@pintahub/database-schemas 4.4.8 → 4.6.0

package/schemas/Shop.js

@@ -1,13 +1,16 @@
 const {Schema} = require('mongoose')
 
 
+/** Shop within a Store (multi-shop support) */
 const Shop = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Display name */
     name: {
         type: String,
         trim: true,
@@ -15,12 +18,14 @@ const Shop = new Schema({
         index: true,
     },
 
+    /** Status */
     status: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** URL-friendly slug */
     handle: {
         type: String,
         trim: true,
@@ -28,27 +33,32 @@ const Shop = new Schema({
         index: true,
     },
 
+    /** @ref Account — shop owner */
     owner: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Number of products */
     products_count: {
         type: Number,
         default: 0,
         index: true,
     },
 
+    /** Randomize product display order */
     random: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now

package/schemas/ShopifyAPI.js

@@ -1,53 +1,64 @@
 const {Schema} = require('mongoose')
 
 
+/** Shopify API credentials per store */
 const ShopifyAPI = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify Admin API access token */
     admin_access_token: {
         type: String,
         trim: true,
     },
 
+    /** Shopify Storefront API access token */
     storefront_access_token: {
         type: String,
         trim: true,
     },
 
+    /** Shopify session cookies */
     cookies: {
         type: String,
         trim: true,
     },
 
+    /** CSRF protection token */
     csrf_token: {
         type: String,
         trim: true,
     },
 
+    /** Shop app session cookies */
     shop_app_cookies: {
         type: String,
         trim: true,
     },
 
+    /** OAuth client ID */
     client_id: {
         type: String,
         trim: true,
     },
 
+    /** OAuth client secret */
     client_secret: {
         type: String,
         trim: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now
@@ -55,4 +66,3 @@ const ShopifyAPI = new Schema({
 })
 
 module.exports = ShopifyAPI
-

package/schemas/ShopifyObject.js

@@ -1,73 +1,87 @@
 const {Schema} = require('mongoose')
 
 
+/** Synced Shopify data object (pages, themes, scripts, etc.) */
 const ShopifyObject = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify object ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Object type, e.g. 'page', 'theme', 'script_tag' */
     type: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Sub-type for further classification */
     sub_type: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** URL-friendly slug */
     handle: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Display title */
     title: {
         type: String,
         trim: true,
     },
 
+    /** Content body */
     body: {
         type: String,
         trim: true,
     },
 
+    /** Raw Shopify data */
     data: {
         type: Schema.Types.Mixed,
         default: {},
     },
 
+    /** Shopify sync identifier */
     sync_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** 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
     }
 })
 
+/** Compound index for querying by store + type + sub_type */
 ShopifyObject.index({
     store: 1,
     type: 1,
@@ -75,4 +89,3 @@ ShopifyObject.index({
 })
 
 module.exports = ShopifyObject
-

package/schemas/ShortDomain.js

@@ -1,51 +1,61 @@
 const {Schema} = require('mongoose')
 
 
+/** Short link domain */
 const ShortDomain = new Schema({
+    /** Domain hostname */
     domain: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Status */
     status: {
         type: String,
         index: true,
         default: 'active'
     },
 
+    /** Brand color for UI display */
     color: {
         type: String,
         trim: true,
     },
 
+    /** Default redirect URL when no slug matches */
     redirect_to: {
         type: String,
         trim: true,
     },
 
+    /** Whether this domain belongs to a store */
     is_store: {
         type: Boolean,
         default: false,
         index: true,
     },
 
+    /** Total click count */
     clicks_count: {
         type: Number,
         default: 0,
         index: true
     },
 
+    /** @ref Account — users who can create short links on this domain */
     users: {
         type: [Schema.Types.ObjectId],
         index: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now
@@ -53,4 +63,3 @@ const ShortDomain = new Schema({
 })
 
 module.exports = ShortDomain
-

package/schemas/ShortLog.js

@@ -1,49 +1,59 @@
 const {Schema} = require('mongoose')
 
 
+/** Click tracking log for short URLs */
 const ShortLog = new Schema({
+    /** @ref ShortUrl */
     short: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Clicked short URL */
     url: {
         type: String,
         trim: true,
         required: true
     },
 
+    /** Final destination URL */
     destination_url: {
         type: String,
         trim: true,
     },
 
+    /** Browser user agent string */
     user_agent: {
         type: String,
         trim: true,
     },
 
+    /** HTTP referer header */
     referer: {
         type: String,
         trim: true,
     },
 
+    /** Country code */
     country: {
         type: String,
         trim: true,
     },
 
+    /** IP address */
     ip: {
         type: String,
         trim: true,
     },
 
+    /** Visitor type: 'human' or 'bot' */
     viewer_type: {
         type: String,
         trim: true,
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,

package/schemas/ShortUrl.js

@@ -1,7 +1,9 @@
 const {Schema} = require('mongoose')
 
 
+/** Short link (slug + domain → destination URL) */
 const ShortUrl = new Schema({
+    /** Full destination URL */
     url: {
         type: String,
         trim: true,
@@ -9,65 +11,77 @@ const ShortUrl = new Schema({
         index: true,
     },
 
+    /** Domain of the destination URL */
     destination_domain: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Short path segment */
     slug: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Short link domain */
     domain: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** @ref ShortDomain */
     domain_id: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Status */
     status: {
         type: String,
         index: true,
         default: 'active'
     },
 
+    /** @ref Account — last editor */
     edited_by: {
         type: Schema.Types.ObjectId,
     },
 
+    /** @ref Account — creator */
     created_by: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Total click count */
     clicks_count: {
         type: Number,
         default: 0
     },
 
+    /** Clicks removed (e.g. bot clicks cleaned up) */
     deleted_clicks: {
         type: Number,
         default: 0
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now
     }
 })
 
+/** Compound index: unique short link per slug + domain */
 ShortUrl.index({
     slug: 1,
     domain: 1

package/schemas/Store.js

@@ -1,40 +1,52 @@
 const {Schema} = require('mongoose')
 
 
+/** Main store entity */
 const Store = new Schema({
+    /** Display name */
     name: {
         type: String,
         trim: true,
     },
 
+    /** Store subdomain (e.g. 'mystore' for mystore.pintahub.com) */
     subdomain: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Custom primary domain */
     primary_domain: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Store number identifier */
     number: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Checkout page domain */
     checkout_domain: {
         type: String,
         trim: true,
     },
 
+    /** Shopify shop ID */
     shop_id: {
         type: String,
         trim: true,
     },
 
+    /**
+     * Store status:
+     * - active: store is live
+     * - inactive: store is disabled
+     */
     status: {
         type: String,
         default: 'active',
@@ -42,36 +54,43 @@ const Store = new Schema({
         index: true
     },
 
+    /** @ref StoreSetting */
     setting: {
         type: Schema.Types.ObjectId,
     },
 
+    /** Maintenance mode message (null = not in maintenance) */
     maintenance_mode: {
         type: String,
         trim: true
     },
 
+    /** SEO indexing: 'enabled' or 'disabled' */
     search_engine_indexing: {
         type: String,
         trim: true,
         default: 'enabled',
     },
 
+    /** @ref Account — users with access to this store */
     users: {
         type: [Schema.Types.ObjectId],
         index: true,
     },
 
+    /** Shopify Shop app ID */
     shop_app_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
@@ -79,4 +98,3 @@ const Store = new Schema({
 })
 
 module.exports = Store
-

package/schemas/StoreEvent.js

@@ -1,24 +1,29 @@
 const {Schema} = require('mongoose')
 
 
+/** Store activity event (analytics tracking) */
 const StoreEvent = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** @ref Product — related product (if applicable) */
     product: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Visitor session identifier */
     session_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Event name, e.g. 'page_view', 'add_to_cart', 'purchase' */
     name: {
         type: String,
         trim: true,
@@ -26,15 +31,18 @@ const StoreEvent = new Schema({
         index: true,
     },
 
+    /** URL */
     url: {
         type: String,
         trim: true,
     },
 
+    /** IP address */
     ip: {
         type: String,
     },
 
+    /** ISO country code (uppercase) */
     country: {
         type: String,
         trim: true,
@@ -42,28 +50,33 @@ const StoreEvent = new Schema({
         uppercase: true,
     },
 
+    /** Browser user agent string */
     user_agent: {
         type: String,
         trim: true,
     },
 
+    /** Extra event metadata */
     meta: {
         type: Schema.Types.Mixed,
         default: {}
     },
 
+    /** Visitor type: 'human' or 'bot' */
     viewer_type: {
         type: String,
         trim: true,
         default: 'human'
     },
 
+    /** HTTP referrer domain */
     referrer_domain: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,
@@ -73,4 +86,3 @@ const StoreEvent = new Schema({
 
 
 module.exports = StoreEvent
-