rerobe-js-orm 4.9.14 → 4.9.16

package/lib/constants/order-constants.d.ts

@@ -31,6 +31,7 @@ export namespace SALES_CHANNELS {
     let ribbnSellThroughChannelPartner: string;
     let ribbnSellOnChannelPartner: string;
 }
+export const POS_SALES_CHANNELS: string[];
 export namespace FULFILLMENT_TYPES {
     let fulfilled: string;
     let partiallyFulfilled: string;

package/lib/constants/order-constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SALES_CHANNEL_TO_RETURN_POLICY_MAPPING = exports.RETURN_POLICY_TYPES = exports.FINANCIAL_TYPES = exports.FULFILLMENT_TYPES = exports.SALES_CHANNELS = exports.ORDER_STATES = exports.PAYMENT_TYPES = exports.SHIPPING_TYPES = void 0;
+exports.SALES_CHANNEL_TO_RETURN_POLICY_MAPPING = exports.RETURN_POLICY_TYPES = exports.FINANCIAL_TYPES = exports.FULFILLMENT_TYPES = exports.POS_SALES_CHANNELS = exports.SALES_CHANNELS = exports.ORDER_STATES = exports.PAYMENT_TYPES = exports.SHIPPING_TYPES = void 0;
 exports.SHIPPING_TYPES = {
     localPickUp: 'LOCAL_PICK_UP',
     localDelivery: 'LOCAL_DELIVERY',
@@ -34,6 +34,11 @@ exports.SALES_CHANNELS = {
     ribbnSellThroughChannelPartner: 'RIBBN_SELL_THROUGH_CHANNEL_PARTNER',
     ribbnSellOnChannelPartner: 'RIBBN_SELL_ON_CHANNEL_PARTNER',
 };
+// Point-of-sale / in-person channels: the customer is handed the goods at the
+// moment of sale, so every item is fulfilled at sale time (there is no separate
+// fulfillment step, and no per-item fulfillment record is created). `store` is a
+// legacy in-person store-sale channel, treated the same.
+exports.POS_SALES_CHANNELS = [exports.SALES_CHANNELS.ribbnWebPOS, exports.SALES_CHANNELS.ribbnMobilePOS, exports.SALES_CHANNELS.store];
 exports.FULFILLMENT_TYPES = {
     fulfilled: 'FULFILLED',
     partiallyFulfilled: 'PARTIALLY_FULFILLED',

package/lib/helpers/OrderHelpers.d.ts

@@ -15,6 +15,9 @@ export default class OrderHelpers {
         currencyCode: string;
     };
     getAmountSumByField(array: OrderRefund[] | ReRobeOrderLineItem[], fieldKey: string): number;
+    isPosOrder(order: {
+        salesChannel?: string | null;
+    } | null | undefined): boolean;
     getOrderInfoWithRefundsAndFulfillments(order: CompleteOrder): OrderWithRefundsAndFulfillmentsInfoObj;
     getUpdatedOrderObjWithRefunds(orderObj: CompleteOrder, refundObj: OrderRefund): CompleteOrder;
     getUpdatedOrderObjWithFulfillment(orderObj: CompleteOrder, fulfillmentObj: FulfillmentAdmin, totalUnfulfilledItems: number): CompleteOrder;

package/lib/helpers/OrderHelpers.js

@@ -160,11 +160,21 @@ class OrderHelpers {
     getAmountSumByField(array, fieldKey) {
         return array.map((item) => { var _a; return Number(((_a = item[fieldKey]) === null || _a === void 0 ? void 0 : _a.amount) || 0); }).reduce((a, b) => a + b, 0);
     }
+    // Point-of-sale / in-person sale (Ribbn POS or the Ribbn Mobile App): goods are
+    // handed over at the moment of sale, so all items are fulfilled at sale time.
+    isPosOrder(order) {
+        return order_constants_1.POS_SALES_CHANNELS.includes((order && order.salesChannel) || '');
+    }
     getOrderInfoWithRefundsAndFulfillments(order) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
         const orderRefunds = order.refunds ? [...order.refunds] : [];
         const orderFulfillment = order.fulfillments ? [...order.fulfillments] : [];
         const orderLineItems = order.lineItems && Array.isArray(order.lineItems) ? [...order.lineItems] : [];
+        // POS / in-person orders fulfill every item at sale and never create per-item
+        // fulfillment records, so without this they'd all bucket as "unfulfilled"
+        // (and a refund would strand the non-returned items there). When there are no
+        // real fulfillment records, baseline every item as fulfilled instead.
+        const posFulfilledBaseline = this.isPosOrder(order) && !orderFulfillment.length;
         const subtotalPrice = Object.assign(Object.assign({}, order.subtotalPrice), { amount: this.getSubtotalPrice(orderLineItems) });
         const subtotalPricePresentment = Object.assign(Object.assign({}, order.subtotalPricePresentment), { amount: this.getAmountSumByField(orderLineItems, 'presentmentTotalPrice') });
         const preparedOrder = {
@@ -226,6 +236,10 @@ class OrderHelpers {
             });
             preparedOrder.fulfilledItems = preparedOrder.activeLineItems.filter(({ fulfilledQuantity }) => fulfilledQuantity > 0);
         }
+        else if (posFulfilledBaseline) {
+            preparedOrder.activeLineItems = preparedOrder.activeLineItems.map((item) => (Object.assign(Object.assign({}, item), { fulfilledQuantity: Number(item.quantity), unfulfilledQuantity: 0 })));
+            preparedOrder.fulfilledItems = [...preparedOrder.activeLineItems];
+        }
         preparedOrder.unfulfilledItems = preparedOrder.activeLineItems.filter(({ unfulfilledQuantity }) => unfulfilledQuantity > 0);
         if (!orderRefunds.length) {
             return preparedOrder;
@@ -277,6 +291,16 @@ class OrderHelpers {
             }, { refundedQuantity: 0, canceledQuantity: 0 });
             // 3. fulfilledQuantity = (sum of order.fulfillment) - refundedQuantity
             // 4. quantity = unfulfilled quantity (prev quantity - sum of order.fulfillment) - cancelled
+            //
+            // POS / in-person: every item started fulfilled, so a return (recorded as a
+            // refund OR a cancel, depending on the refund flow) comes out of the
+            // fulfilled quantity — never out of unfulfilled (which is 0 here). Otherwise
+            // a returned POS item would stay in the fulfilled bucket AND show as removed.
+            if (posFulfilledBaseline) {
+                return Object.assign(Object.assign(Object.assign({}, item), { fulfilledQuantity: Number(item.fulfilledQuantity) -
+                        refundedAndCanceledQuantity.refundedQuantity -
+                        refundedAndCanceledQuantity.canceledQuantity, unfulfilledQuantity: 0 }), refundedAndCanceledQuantity);
+            }
             return Object.assign(Object.assign(Object.assign({}, item), { fulfilledQuantity: Number(item.fulfilledQuantity) - refundedAndCanceledQuantity.refundedQuantity, unfulfilledQuantity: Number(item.unfulfilledQuantity) - refundedAndCanceledQuantity.canceledQuantity }), refundedAndCanceledQuantity);
         });
         // Active lineItems - not refunded and not removed(not canceled) positions

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rerobe-js-orm",
-  "version": "4.9.14",
+  "version": "4.9.16",
   "description": "ReRobe's Javascript ORM Framework",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",