refactor: updates to inventory counts and statuses

imports/collections/schemas/catalog.js

@@ -122,14 +122,17 @@ export const SocialMetadata = new SimpleSchema({
  * @type {SimpleSchema}
  * @property {String} _id required
  * @property {String} barcode optional
+ * @property {Boolean} canBackorder required, Indicates when the seller has allowed the sale of product which is not in stock
  * @property {Date} createdAt required
  * @property {Number} height optional, default value: `0`
  * @property {Number} index required
- * @property {Boolean} inventoryManagement required
- * @property {Boolean} inventoryPolicy required
- * @property {Boolean} isBackorder required
- * @property {Boolean} isLowQuantity required
- * @property {Boolean} isSoldOut required
+ * @property {Boolean} inventoryAvailableToSell required, The quantity of this item currently available to sell. This number does not include reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator). If this is a variant, this number is created by summing all child option inventory numbers. This is most likely the quantity to display in the storefront UI.
+ * @property {Boolean} inventoryInStock required, The quantity of this item currently in stock. This number is updated when an order is processed by the operator. This number includes all inventory, including reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator). If this is a variant, this number is created by summing all child option inventory numbers. This is most likely just used as a reference in the operator UI, and not displayed in the storefront UI. Called `inventoryQuantity` in the Product Schema, and `inventoryInStock` in the Catalog schema.
+ * @property {Boolean} inventoryManagement required, True if inventory management is enabled for this variant
+ * @property {Boolean} inventoryPolicy required, True if inventory policy is enabled for this variant
+ * @property {Boolean} isBackorder required, Indicates when a product is currently backordered
+ * @property {Boolean} isLowQuantity required, Indicates that the product quantity is too low
+ * @property {Boolean} isSoldOut required, Indicates when the product quantity is zero
  * @property {Number} length optional, default value: `0`
  * @property {Number} lowInventoryWarningThreshold optional, default value: `0`
  * @property {ImageInfo[]} media optional
@@ -158,6 +161,10 @@ export const VariantBaseSchema = new SimpleSchema({
     label: "Barcode",
     optional: true
   },
+  "canBackorder": {
+    type: Boolean,
+    label: "Can backorder"
+  },
   "createdAt": {
     type: Date,
     label: "Date/time this variant was created at"
@@ -173,26 +180,34 @@ export const VariantBaseSchema = new SimpleSchema({
     type: SimpleSchema.Integer,
     label: "The position of this variant among other variants at the same level of the product-variant-option hierarchy"
   },
+  "inventoryAvailableToSell": {
+    type: SimpleSchema.Integer,
+    label: "Inventory available to sell"
+  },
+  "inventoryInStock": {
+    type: SimpleSchema.Integer,
+    label: "Inventory in stock"
+  },
   "inventoryManagement": {
     type: Boolean,
-    label: "True if inventory management is enabled for this variant"
+    label: "Inventory management"
   },
   "inventoryPolicy": {
     type: Boolean,
-    label: "True if inventory policy is enabled for this variant"
+    label: "Inventory policy"
   },
   "isBackorder": {
     type: Boolean,
-    label: "Indicates when the seller has allowed the sale of product which is not in stock",
+    label: "Is backordered",
     defaultValue: false
   },
   "isLowQuantity": {
     type: Boolean,
-    label: "Indicates that the product quantity is too low"
+    label: "Is low quantity"
   },
   "isSoldOut": {
     type: Boolean,
-    label: "Indicates when the product quantity is zero"
+    label: "Is sold out"
   },
   "length": {
     type: Number,
@@ -320,10 +335,11 @@ export const CatalogVariantSchema = VariantBaseSchema.clone().extend({
  * @property {Date} createdAt required
  * @property {String} description optional
  * @property {Number} height optional, default value: `0`
- * @property {Boolean} isBackorder required
- * @property {Boolean} isDeleted required, default value: `false`
- * @property {Boolean} isLowQuantity required
- * @property {Boolean} isSoldOut required
+ * @property {Boolean} inventoryAvailableToSell required, The quantity of this item currently available to sell. This number does not include reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator). If this is a variant, this number is created by summing all child option inventory numbers. This is most likely the quantity to display in the storefront UI.
+ * @property {Boolean} inventoryInStock required, The quantity of this item currently in stock. This number is updated when an order is processed by the operator. This number includes all inventory, including reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator). If this is a variant, this number is created by summing all child option inventory numbers. This is most likely just used as a reference in the operator UI, and not displayed in the storefront UI. Called `inventoryQuantity` in the Product Schema, and `inventoryInStock` in the Catalog schema.
+ * @property {Boolean} isBackorder required, Indicates when a product is currently backordered
+ * @property {Boolean} isLowQuantity required, Indicates that the product quantity is too low
+ * @property {Boolean} isSoldOut required, Indicates when the product quantity is zero
  * @property {Boolean} isVisible required, default value: `false`
  * @property {Number} length optional, default value: `0`
  * @property {Number} lowInventoryWarningThreshold optional, default value: `0`
@@ -380,23 +396,31 @@ export const CatalogProduct = new SimpleSchema({
     optional: true,
     defaultValue: 0
   },
+  "inventoryAvailableToSell": {
+    type: SimpleSchema.Integer,
+    label: "Inventory available to sell"
+  },
+  "inventoryInStock": {
+    type: SimpleSchema.Integer,
+    label: "Inventory in stock"
+  },
   "isBackorder": {
     type: Boolean,
-    label: "Indicates when the seller has allowed the sale of product which is not in stock"
+    label: "Is backorder"
   },
   "isDeleted": {
     type: Boolean,
-    label: "Indicates when a product is archived",
+    label: "Is deleted",
     index: 1,
     defaultValue: false
   },
   "isLowQuantity": {
     type: Boolean,
-    label: "Indicates that the product quantity is too low"
+    label: "Is low quantity"
   },
   "isSoldOut": {
     type: Boolean,
-    label: "Indicates when the product quantity is zero"
+    label: "Is sold out"
   },
   "isVisible": {
     type: Boolean,

imports/collections/schemas/products.js

@@ -57,6 +57,8 @@ registerSchema("VariantMedia", VariantMedia);
  * @property {Event[]} eventLog optional, Variant Event Log
  * @property {Number} height optional, default value: `0`
  * @property {Number} index optional, Variant position number in list. Keep array index for moving variants in a list.
+ * @property {Boolean} inventoryAvailableToSell required
+ * @property {Boolean} inventoryInStock required
  * @property {Boolean} inventoryManagement, default value: `true`
  * @property {Boolean} inventoryPolicy, default value: `false`, If disabled, item can be sold even if it not in stock.
  * @property {Number} inventoryQuantity, default value: `0`
@@ -168,15 +170,29 @@ export const ProductVariant = new SimpleSchema({
       }
     }
   },
+  "inventoryAvailableToSell": {
+    type: SimpleSchema.Integer,
+    label: "The quantity of this item currently available to sell." +
+    "This number is updated when an order is placed by the customer." +
+    "This number does not include reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator)." +
+    "If this is a variant, this number is created by summing all child option inventory numbers." +
+    "This is most likely the quantity to display in the storefront UI.",
+    optional: true,
+    defaultValue: 0
+  },
   "inventoryQuantity": {
     type: SimpleSchema.Integer,
-    label: "Quantity",
+    label: "The quantity of this item currently in stock." +
+    "This number is updated when an order is processed by the operator." +
+    "This number includes all inventory, including reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator)." +
+    "If this is a variant, this number is created by summing all child option inventory numbers." +
+    "This is most likely just used as a reference in the operator UI, and not displayed in the storefront UI." +
+    "Called `inventoryQuantity` in the Product Schema, and `inventoryInStock` in the Catalog schema.",
     optional: true,
     defaultValue: 0
   },
   "isBackorder": {
-    label: "Indicates when the seller has allowed the sale of product which" +
-    " is not in stock",
+    label: "Indicates when a product is currently backordered",
     type: Boolean,
     optional: true
   },
@@ -339,6 +355,8 @@ registerSchema("PriceRange", PriceRange);
  * @property {String} googleplusMsg optional
  * @property {String} handle optional, slug
  * @property {String[]} hashtags optional
+ * @property {Boolean} inventoryAvailableToSell required
+ * @property {Boolean} inventoryInStock required
  * @property {Boolean} isBackorder denormalized, `true` if product not in stock, but customers anyway could order it
  * @property {Boolean} isDeleted, default value: `false`
  * @property {Boolean} isLowQuantity denormalized, true when at least 1 variant is below `lowInventoryWarningThreshold`
@@ -414,9 +432,29 @@ export const Product = new SimpleSchema({
   "hashtags.$": {
     type: String
   },
+  "inventoryAvailableToSell": {
+    type: SimpleSchema.Integer,
+    label: "The quantity of this item currently available to sell." +
+    "This number is updated when an order is placed by the customer." +
+    "This number does not include reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator)." +
+    "If this is a variant, this number is created by summing all child option inventory numbers." +
+    "This is most likely the quantity to display in the storefront UI.",
+    optional: true,
+    defaultValue: 0
+  },
+  "inventoryQuantity": {
+    type: SimpleSchema.Integer,
+    label: "The quantity of this item currently in stock." +
+    "This number is updated when an order is processed by the operator." +
+    "This number includes all inventory, including reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator)." +
+    "If this is a variant, this number is created by summing all child option inventory numbers." +
+    "This is most likely just used as a reference in the operator UI, and not displayed in the storefront UI." +
+    "Called `inventoryQuantity` in the Product Schema, and `inventoryInStock` in the Catalog schema.",
+    optional: true,
+    defaultValue: 0
+  },
   "isBackorder": {
-    label: "Indicates when the seller has allowed the sale of product which" +
-    " is not in stock",
+    label: "Indicates when a product is currently backordered",
     type: Boolean,
     optional: true
   },

imports/plugins/core/cart/server/no-meteor/schemas/cart.graphql

@@ -92,8 +92,10 @@ type CartItem implements Node {
   "The current comparison (e.g., MSRP) price of the item"
   compareAtPrice: Money
 
-  "The quantity of this item currently available to order"
-  currentQuantity: Int
+  """
+  The quantity of this item currently available to order.
+  """
+  currentQuantity: Int @deprecated(reason: "Use `inventoryAvailableToSell`.")
 
   """
   The date and time at which the cart item was created. If an item is added, removed, and then added again,
@@ -104,6 +106,14 @@ type CartItem implements Node {
   "The URLs for a picture of the item in various sizes"
   imageURLs: ImageSizes
 
+  """
+  The quantity of this item currently available to sell.
+  This number is updated when an order is placed by the customer.
+  This number does not include reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator).
+  This is most likely the quantity to display in the storefront UI.
+  """
+  inventoryAvailableToSell: Int
+
   "Is this item currently backordered?"
   isBackorder: Boolean!
 

imports/plugins/core/catalog/server/methods/catalog.js

@@ -10,16 +10,17 @@ import Reaction from "/imports/plugins/core/core/server/Reaction";
 import ReactionError from "@reactioncommerce/reaction-error";
 import { MediaRecords, Products, Tags } from "/lib/collections";
 import { Media } from "/imports/plugins/core/files/server";
+import appEvents from "/imports/node-app/core/util/appEvents";
 import rawCollections from "/imports/collections/rawCollections";
 import getGraphQLContextInMeteorMethod from "/imports/plugins/core/graphql/server/getGraphQLContextInMeteorMethod";
 import hashProduct from "../no-meteor/mutations/hashProduct";
 import getCurrentCatalogPriceForProductConfiguration from "../no-meteor/queries/getCurrentCatalogPriceForProductConfiguration";
 import getProductPriceRange from "../no-meteor/utils/getProductPriceRange";
 import getVariants from "../no-meteor/utils/getVariants";
 import hasChildVariant from "../no-meteor/utils/hasChildVariant";
-import isSoldOut from "../no-meteor/utils/isSoldOut";
-import isLowQuantity from "../no-meteor/utils/isLowQuantity";
-import isBackorder from "../no-meteor/utils/isBackorder";
+import isSoldOut from "/imports/plugins/core/inventory/server/no-meteor/utils/isSoldOut";
+import isLowQuantity from "/imports/plugins/core/inventory/server/no-meteor/utils/isLowQuantity";
+import isBackorder from "/imports/plugins/core/inventory/server/no-meteor/utils/isBackorder";
 
 /* eslint new-cap: 0 */
 /* eslint no-loop-func: 0 */
@@ -997,6 +998,9 @@ Meteor.methods({
         denormalize(doc.ancestors[0], field);
       }
     }
+
+    appEvents.emit("afterVariantUpdate", { _id, field, value });
+
     return update;
   },
 

imports/plugins/core/catalog/server/no-meteor/schemas/schema.graphql

@@ -143,7 +143,26 @@ type CatalogProduct implements CatalogProductOrVariant & Node {
   "The height of the product, if it has physical dimensions"
   height: Float
 
-  "True if isSoldOut is true AND none of the variants have an inventoryPolicy set"
+  """
+  The quantity of this item currently available to sell.
+  This number is updated when an order is placed by the customer.
+  This number does not include reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator).
+  This number is calculated by summing all child variant inventory numbers.
+  This is most likely the quantity to display in the storefront UI.
+  """
+  inventoryAvailableToSell: Int
+
+  """
+  The quantity of this item currently in stock.
+  This number is updated when an order is processed by the operator.
+  This number includes all inventory, including reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator).
+  This number is calculated by summing all child variant inventory numbers.
+  This is most likely just used as a reference in the operator UI, and not displayed in the storefront UI.
+  Called `inventoryQuantity` in the Product Schema, and `inventoryInStock` in the Catalog schema.
+  """
+  inventoryInStock: Int
+
+  "True if isSoldOut is true AND none of the variants have an inventoryPolicy set AND available inventory is 0"
   isBackorder: Boolean!
 
   "True if this product has been deleted. Typically, deleted products are not returned in queries."
@@ -247,6 +266,9 @@ type CatalogProductVariant implements CatalogProductOrVariant & Node {
   "The product variant barcode value, if it has one"
   barcode: String
 
+  "Indicates when the seller has allowed the sale of product which is not in stock. True if inventoryManagement is true AND none of the variants have an inventoryPolicy set."
+  canBackorder: Boolean!
+
   "The date and time at which this CatalogProductVariant was created, which is when the related product was first published"
   createdAt: DateTime
 
@@ -256,13 +278,32 @@ type CatalogProductVariant implements CatalogProductOrVariant & Node {
   "The position of this variant among other variants at the same level of the product-variant-option hierarchy"
   index: Int!
 
+  """
+  The quantity of this item currently available to sell.
+  This number is updated when an order is placed by the customer.
+  This number does not include reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator).
+  If this is a variant, this number is created by summing all child option inventory numbers.
+  This is most likely the quantity to display in the storefront UI.
+  """
+  inventoryAvailableToSell: Int
+
+  """
+  The quantity of this item currently in stock.
+  This number is updated when an order is processed by the operator.
+  This number includes all inventory, including reserved inventory (i.e. inventory that has been ordered, but not yet processed by the operator).
+  If this is a variant, this number is created by summing all child option inventory numbers.
+  This is most likely just used as a reference in the operator UI, and not displayed in the storefront UI.
+  Called `inventoryQuantity` in the Product Schema, and `inventoryInStock` in the Catalog schema.
+  """
+  inventoryInStock: Int
+
   "True if inventory management is enabled for this variant"
   inventoryManagement: Boolean!
 
   "True if inventory policy is enabled for this variant"
   inventoryPolicy: Boolean!
 
-  "True if isSoldOut is true AND none of the variants have an inventoryPolicy set"
+  "True if isSoldOut is true AND none of the variants have an inventoryPolicy set AND available inventory is 0"
   isBackorder: Boolean!
 
   "True if inventoryManagement is enabled and this variant has an available quantity less than its lowInventoryWarningThreshold"

imports/plugins/core/catalog/server/no-meteor/utils/canBackorder.js

@@ -0,0 +1,10 @@
+/**
+ * @method canBackorder
+ * @summary If all the products variants have inventory policy disabled and inventory management enabled
+ * @memberof Catalog
+ * @param {Object[]} variants - Array with product variant objects
+ * @return {boolean} is backorder allowed or not for a product
+ */
+export default function canBackorder(variants) {
+  return variants.every((variant) => !variant.inventoryPolicy && variant.inventoryManagement);
+}

imports/plugins/core/catalog/server/no-meteor/utils/canBackorder.test.js

@@ -0,0 +1,38 @@
+import canBackorder from "./canBackorder";
+
+// mock variant
+const mockVariantWithBackorder = {
+  inventoryManagement: true,
+  inventoryPolicy: false
+};
+
+const mockVariantWithOutBackorder = {
+  inventoryManagement: true,
+  inventoryPolicy: true
+};
+
+const mockVariantWithOutInventory = {
+  inventoryManagement: false,
+  inventoryPolicy: false
+};
+
+
+test("expect true when a single product variant is sold out and has inventory policy disabled", () => {
+  const spec = canBackorder([mockVariantWithBackorder]);
+  expect(spec).toBe(true);
+});
+
+test("expect true when an array of product variants are sold out and have inventory policy disabled", () => {
+  const spec = canBackorder([mockVariantWithBackorder, mockVariantWithBackorder]);
+  expect(spec).toBe(true);
+});
+
+test("expect false when a single product variant is sold out and has inventory policy enabled", () => {
+  const spec = canBackorder([mockVariantWithOutBackorder]);
+  expect(spec).toBe(false);
+});
+
+test("expect false when a single product variant is sold out and has inventory controls disabled", () => {
+  const spec = canBackorder([mockVariantWithOutInventory]);
+  expect(spec).toBe(false);
+});