@pintahub/database-schemas 4.5.0 → 4.6.0

package/schemas/Order.js

@@ -2,45 +2,54 @@ const {Schema} = require('mongoose')
 const MoneyObject = require('./MoneyObject')
 
 
+/** Embedded shipping address */
 const ShippingAddress = new Schema({
     _id: false,
 
+    /** Display name */
     name: {
         type: String,
         trim: true
     },
 
+    /** Street address line 1 */
     address1: {
         type: String,
         trim: true
     },
 
+    /** Street address line 2 */
     address2: {
         type: String,
         trim: true
     },
 
+    /** City */
     city: {
         type: String,
         trim: true
     },
 
+    /** State/Province */
     province: {
         type: String,
         trim: true
     },
 
+    /** ZIP/Postal code */
     zip: {
         type: String,
         trim: true
     },
 
+    /** Country code */
     country: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Phone number */
     phone: {
         type: String,
         trim: true
@@ -48,34 +57,41 @@ const ShippingAddress = new Schema({
 })
 
 
+/** Order with shipping, payment, and fulfillment tracking */
 const Order = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true
     },
 
+    /** Shopify order ID */
     id: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Order display name, e.g. '#1001' */
     name: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Order number */
     number: {
         type: String,
         trim: true
     },
 
+    /** Customer shipping address */
     shipping_address: {
         type: ShippingAddress
     },
 
+    /** e.g. 'fulfilled', 'unfulfilled', 'partial' */
     fulfillment_status: {
         type: String,
         trim: true,
@@ -83,6 +99,7 @@ const Order = new Schema({
         lowercase: true
     },
 
+    /** e.g. 'paid', 'pending', 'refunded' */
     financial_status: {
         type: String,
         trim: true,
@@ -90,6 +107,7 @@ const Order = new Schema({
         lowercase: true
     },
 
+    /** Cancellation status */
     cancel_status: {
         type: String,
         trim: true,
@@ -97,94 +115,113 @@ const Order = new Schema({
         lowercase: true
     },
 
+    /** Order total amount */
     total_price: {
         type: MoneyObject
     },
 
+    /** Shipping/fulfillment cost */
     fulfillment_cost: {
         type: MoneyObject
     },
 
+    /** Payment processing fee */
     transaction_fee: {
         type: MoneyObject
     },
 
+    /** Net payout amount */
     payout: {
         type: MoneyObject
     },
 
+    /** Email address */
     email: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Phone number */
     phone: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Shopify order status page URL */
     status_page_url: {
         type: String,
         trim: true
     },
 
+    /** Last Shopify sync timestamp */
     last_synced_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Last time a review notification was requested */
     last_request_notify_at: {
         type: Date,
         index: true
     },
 
+    /** Number of line items */
     items_count: {
         type: Number
     },
 
+    /** Product vendors in this order */
     vendors: {
         type: [String],
         trim: true,
         index: true
     },
 
+    /** Number of distinct vendors */
     vendors_count: {
         type: Number,
         index: true
     },
 
+    /** Payment gateway, e.g. 'shopify_payments', 'paypal' */
     gateway: {
         type: String,
         trim: true,
         index: true
     },
 
+    /** Payment method */
     payment_method: {
         type: String,
         trim: true
     },
 
+    /** Customer's IP address */
     browser_ip: {
         type: String,
         trim: true
     },
 
+    /** Cancellation reason */
     cancel_reason: {
         type: String,
         trim: true
     },
 
+    /** When cancelled */
     cancelled_at: {
         type: Date
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,
@@ -192,6 +229,7 @@ const Order = new Schema({
     }
 })
 
+/** Full-text search index */
 Order.index({
     name: 'text',
     id: 'text',
@@ -201,4 +239,3 @@ Order.index({
 })
 
 module.exports = Order
-

package/schemas/OrderItem.js

@@ -2,88 +2,105 @@ const {Schema} = require('mongoose')
 const MoneyObject = require('./MoneyObject')
 
 
+/** Order line item */
 const OrderItem = 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 line item ID */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Cancellation status */
     cancel_status: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** @ref Product */
     product: {
         type: Schema.Types.ObjectId,
         index: true,
     },
 
+    /** Item quantity */
     quantity: {
         type: Number,
         default: 1,
     },
 
+    /** Line item price */
     price: {
         type: MoneyObject,
     },
 
+    /** Fulfillment status */
     fulfillment_status: {
         type: String,
         trim: true,
         lowercase: true,
     },
 
+    /** Shopify product ID (string) */
     product_id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Shopify variant ID */
     variant_id: {
         type: String,
         trim: true,
     },
 
+    /** Variant display title, e.g. 'Red / XL' */
     variant_title: {
         type: String,
         trim: true,
     },
 
+    /** Product type */
     product_type: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Product vendor */
     vendor: {
         type: String,
         trim: true,
     },
 
+    /** Shopify image ID for this line item */
     image_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,
@@ -92,4 +109,3 @@ const OrderItem = new Schema({
 })
 
 module.exports = OrderItem
-

package/schemas/Payout.js

@@ -2,19 +2,23 @@ const {Schema} = require('mongoose')
 const MoneyObject = require('./MoneyObject')
 
 
+/** Payment payout from payment provider */
 const Payout = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Payout ID from payment provider */
     id: {
         type: String,
         trim: true,
         index: true,
     },
 
+    /** Payout status, e.g. 'paid', 'pending' */
     status: {
         type: String,
         trim: true,
@@ -22,31 +26,37 @@ const Payout = new Schema({
         lowercase: true,
     },
 
+    /** Net payout amount */
     net: {
         type: MoneyObject,
     },
 
+    /** When the payout was issued */
     issued_at: {
         type: Date,
         index: true,
     },
 
+    /** Payout type, e.g. 'deposit', 'withdrawal' */
     type: {
         type: String,
         trim: true,
         lowercase: true,
     },
 
+    /** Last sync from payment provider */
     synced_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,
@@ -56,4 +66,3 @@ const Payout = new Schema({
 
 
 module.exports = Payout
-

package/schemas/Post.js

@@ -2,23 +2,28 @@ const {Schema} = require('mongoose')
 const ImageObject = require('./ImageObject')
 
 
+/** Embedded blog post author */
 const AuthorObject = new Schema({
     _id: false,
 
+    /** Display name */
     name: {
         type: String,
         trim: true,
     },
 })
 
+/** Embedded SEO metadata */
 const SEOObject = new Schema({
     _id: false,
 
+    /** Display title */
     title: {
         type: String,
         trim: true,
     },
 
+    /** Description */
     description: {
         type: String,
         trim: true,
@@ -26,68 +31,82 @@ const SEOObject = new Schema({
 })
 
 
+/** Blog post */
 const Post = new Schema({
+    /** @ref Store */
     store: {
         type: Schema.Types.ObjectId,
         index: true,
         required: true,
     },
 
+    /** Shopify post 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,
     },
 
+    /** Full post content in HTML */
     body_html: {
         type: String,
         trim: true,
     },
 
+    /** Short excerpt/summary */
     excerpt: {
         type: String,
         trim: true,
     },
 
+    /** Post author */
     author: {
         type: AuthorObject,
     },
 
+    /** Tags */
     tags: {
         type: [String],
         index: true,
         trim: true,
     },
 
+    /** SEO metadata */
     seo: {
         type: SEOObject,
     },
 
+    /** Featured image */
     featured_image: {
         type: ImageObject,
     },
 
+    /** Publish date */
     published_at: {
         type: Date,
         index: true,
     },
 
+    /** Last update timestamp */
     updated_at: {
         type: Date,
         default: Date.now
     },
 
+    /** Record creation timestamp */
     created_at: {
         type: Date,
         default: Date.now,
@@ -96,4 +115,3 @@ const Post = new Schema({
 })
 
 module.exports = Post
-

package/schemas/PriceRange.js

@@ -1,26 +1,32 @@
 const {Schema} = require('mongoose')
 
 
+/** Embedded price with currency */
 const PriceObject = new Schema({
     _id: false,
 
+    /** Price amount */
     amount: {
         type: Number,
     },
 
+    /** ISO 4217 currency code, default 'USD' */
     currencyCode: {
         type: String,
         default: 'USD',
     }
 })
 
+/** Embedded product price range (min/max variant prices) */
 const PriceRange = new Schema({
     _id: false,
 
+    /** Lowest variant price */
     minVariantPrice: {
         type: PriceObject,
     },
 
+    /** Highest variant price */
     maxVariantPrice: {
         type: PriceObject,
     }