rerobe-js-orm 4.8.2 → 4.8.3

package/lib/helpers/OrderHelpers.d.ts

@@ -47,12 +47,15 @@ export default class OrderHelpers {
     getPaymentTerminalReceiptInfo(payload?: any): PaymentTerminalReceiptInfo;
     getFormattedFulfillmentLocation(order: ReRobeOrderObj): string;
     generateReceiptLabels(locale: string, paymentMethod: string, entryMode?: string): ReceiptLabels;
-    buildReceiptObjFromOrder({ order, merchant, merchantLogoUrl, receiptNumber, additionalInfo, }: {
+    buildReceiptObjFromOrder({ order, merchant, merchantLogoUrl, receiptNumber, additionalInfo, isRefund, refundId, originalReceiptNumber, }: {
         order: ReRobeOrderObj;
         merchant: MerchantObj;
         merchantLogoUrl: string;
         receiptNumber: string;
         additionalInfo: string;
+        isRefund?: boolean;
+        refundId?: string | null;
+        originalReceiptNumber?: string | null;
     }): ReceiptObj;
     /**
      * Generates an idempotency key from a ReRobeOrderObj to prevent duplicate order creation

package/lib/helpers/OrderHelpers.js

@@ -579,23 +579,29 @@ class OrderHelpers {
             entryModeLabel,
         };
     }
-    buildReceiptObjFromOrder({ order, merchant, merchantLogoUrl = '', receiptNumber = '', additionalInfo = '', }) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    buildReceiptObjFromOrder({ order, merchant, merchantLogoUrl = '', receiptNumber = '', additionalInfo = '', isRefund = false, refundId = null, originalReceiptNumber = null, }) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q;
         const { address: merchantAddress, legalName, name, contactEmail, phone = '', organizationNumber = '', primaryDomain, currency: storeCurrencyCode, returnPolicy, } = merchant;
         const currencyCode = ((_a = order.totalPricePresentment) === null || _a === void 0 ? void 0 : _a.currencyCode) || storeCurrencyCode;
         const presentmentLocale = (0, Utilities_1.getPresentmentLocaleByCurrencyCode)(currencyCode);
         const mapLineItem = (l) => {
-            var _a, _b, _c;
+            var _a, _b, _c, _d, _e;
             let totalPrice = Number((_a = l.presentmentTotalPrice) === null || _a === void 0 ? void 0 : _a.amount);
             if (l.isTaxable && l.taxRate) {
                 const taxRate = Number(l.taxRate);
                 totalPrice *= 1 + taxRate;
             }
+            if (isRefund) {
+                totalPrice = -Math.abs(totalPrice);
+            }
             let title = l.title || l.brand || '';
             if (Number(l === null || l === void 0 ? void 0 : l.quantity) > 1) {
+                const unitPrice = isRefund
+                    ? -Math.abs(Number((_c = (_b = l === null || l === void 0 ? void 0 : l.originalUnitPrice) === null || _b === void 0 ? void 0 : _b.amount) !== null && _c !== void 0 ? _c : 0))
+                    : (_e = (_d = l === null || l === void 0 ? void 0 : l.originalUnitPrice) === null || _d === void 0 ? void 0 : _d.amount) !== null && _e !== void 0 ? _e : '';
                 title += `\n${Number(l === null || l === void 0 ? void 0 : l.quantity)} x ${(0, Utilities_1.formatPrice)({
                     currencyCode,
-                    amount: (_c = (_b = l === null || l === void 0 ? void 0 : l.originalUnitPrice) === null || _b === void 0 ? void 0 : _b.amount) !== null && _c !== void 0 ? _c : '',
+                    amount: unitPrice,
                     fractionDigits: 2,
                 })}`;
             }
@@ -642,7 +648,8 @@ class OrderHelpers {
                 if (!acc[cur.taxRate]) {
                     acc[cur.taxRate] = 0;
                 }
-                acc[cur.taxRate] += Number(cur.taxAmount);
+                const amount = Number(cur.taxAmount);
+                acc[cur.taxRate] += isRefund ? -Math.abs(amount) : amount;
                 acc[cur.taxRate] = parseFloat(acc[cur.taxRate].toFixed(2));
             }
             return acc;
@@ -664,31 +671,42 @@ class OrderHelpers {
         };
         const paymentTerminalInfo = this.getPaymentTerminalReceiptInfo(order);
         const receiptLabels = this.generateReceiptLabels(presentmentLocale, (_b = order.paymentType) !== null && _b !== void 0 ? _b : '', (_c = paymentTerminalInfo.entryMode) !== null && _c !== void 0 ? _c : '');
+        if (isRefund) {
+            receiptLabels.receiptLabel = translations_1.refundReceiptTranslations[presentmentLocale] || translations_1.refundReceiptTranslations['en-US'];
+            receiptLabels.purchaseLabel =
+                translations_1.refundPurchaseTranslations[presentmentLocale] || translations_1.refundPurchaseTranslations['en-US'];
+        }
         let info = additionalInfo;
-        if (returnPolicy) {
+        if (returnPolicy && !isRefund) {
             info = `${returnPolicy}`;
             if (additionalInfo) {
                 info = `${info}\n\n${additionalInfo}`;
             }
         }
+        const negateForRefund = (amount) => {
+            if (!isRefund)
+                return amount;
+            const num = Number(amount);
+            return isNaN(num) ? amount : -Math.abs(num);
+        };
         return Object.assign(Object.assign({ merchantLogoUrl, merchantName: name, legalName, storeAddress: buildStoreAddress(), phone,
             contactEmail,
             organizationNumber,
-            primaryDomain, storeUrl: `https://${primaryDomain}`, orderDate: (0, Utilities_1.getFormattedTimestamp)(presentmentLocale, order === null || order === void 0 ? void 0 : order.createdAtTimestamp), receiptNumber, additionalInfo: info, lineItems: buildLineItems(), subTotal: (0, Utilities_1.formatPrice)({
+            primaryDomain, storeUrl: `https://${primaryDomain}`, orderDate: (0, Utilities_1.getFormattedTimestamp)(presentmentLocale, order === null || order === void 0 ? void 0 : order.createdAtTimestamp), receiptNumber, additionalInfo: info, isRefund, originalReceiptNumber: originalReceiptNumber || null, originalReceiptLabel: translations_1.originalReceiptTranslations[presentmentLocale] || translations_1.originalReceiptTranslations['en-US'], lineItems: buildLineItems(), subTotal: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: (_e = (_d = order.subtotalPricePresentment) === null || _d === void 0 ? void 0 : _d.amount) !== null && _e !== void 0 ? _e : '',
+                amount: (_f = negateForRefund((_e = (_d = order.subtotalPricePresentment) === null || _d === void 0 ? void 0 : _d.amount) !== null && _e !== void 0 ? _e : '')) !== null && _f !== void 0 ? _f : '',
                 fractionDigits: 2,
             }), total: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: (_g = (_f = order.totalPricePresentment) === null || _f === void 0 ? void 0 : _f.amount) !== null && _g !== void 0 ? _g : '',
+                amount: (_j = negateForRefund((_h = (_g = order.totalPricePresentment) === null || _g === void 0 ? void 0 : _g.amount) !== null && _h !== void 0 ? _h : '')) !== null && _j !== void 0 ? _j : '',
                 fractionDigits: 2,
             }), amountPaid: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: (_j = (_h = order.totalPricePresentment) === null || _h === void 0 ? void 0 : _h.amount) !== null && _j !== void 0 ? _j : '',
+                amount: (_m = negateForRefund((_l = (_k = order.totalPricePresentment) === null || _k === void 0 ? void 0 : _k.amount) !== null && _l !== void 0 ? _l : '')) !== null && _m !== void 0 ? _m : '',
                 fractionDigits: 2,
             }), tax: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: (_l = (_k = order.totalTaxPresentment) === null || _k === void 0 ? void 0 : _k.amount) !== null && _l !== void 0 ? _l : '',
+                amount: (_q = negateForRefund((_p = (_o = order.totalTaxPresentment) === null || _o === void 0 ? void 0 : _o.amount) !== null && _p !== void 0 ? _p : '')) !== null && _q !== void 0 ? _q : '',
                 fractionDigits: 2,
             }), taxRates: formattedTaxRates }, paymentTerminalInfo), receiptLabels);
     }

package/lib/translations.d.ts

@@ -28,3 +28,12 @@ export declare const contactlessTranslations: {
 export declare const referenceTranslations: {
     [key: string]: string;
 };
+export declare const refundReceiptTranslations: {
+    [key: string]: string;
+};
+export declare const refundPurchaseTranslations: {
+    [key: string]: string;
+};
+export declare const originalReceiptTranslations: {
+    [key: string]: string;
+};

package/lib/translations.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.referenceTranslations = exports.contactlessTranslations = exports.authorizationCodeTranslations = exports.mobilePaymentTranslations = exports.cardPaymentTranslations = exports.cashTranslations = exports.purchaseTranslations = exports.taxTranslations = exports.totalTranslations = exports.receiptTranslations = void 0;
+exports.originalReceiptTranslations = exports.refundPurchaseTranslations = exports.refundReceiptTranslations = exports.referenceTranslations = exports.contactlessTranslations = exports.authorizationCodeTranslations = exports.mobilePaymentTranslations = exports.cardPaymentTranslations = exports.cashTranslations = exports.purchaseTranslations = exports.taxTranslations = exports.totalTranslations = exports.receiptTranslations = void 0;
 exports.receiptTranslations = {
     'sv-SE': 'Kvitto',
     'nb-NO': 'Kvittering',
@@ -71,3 +71,24 @@ exports.referenceTranslations = {
     'en-UK': 'Reference',
     'en-DE': 'Referenz',
 };
+exports.refundReceiptTranslations = {
+    'sv-SE': 'RETUR',
+    'nb-NO': 'RETUR',
+    'en-US': 'REFUND',
+    'en-UK': 'REFUND',
+    'en-DE': 'RÜCKERSTATTUNG',
+};
+exports.refundPurchaseTranslations = {
+    'sv-SE': 'Retur',
+    'nb-NO': 'Retur',
+    'en-US': 'Refund',
+    'en-UK': 'Refund',
+    'en-DE': 'Rückerstattung',
+};
+exports.originalReceiptTranslations = {
+    'sv-SE': 'Originalkvitto',
+    'nb-NO': 'Originalkvittering',
+    'en-US': 'Original receipt',
+    'en-UK': 'Original receipt',
+    'en-DE': 'Originalquittung',
+};

package/lib/types/rerobe-order-types.d.ts

@@ -75,6 +75,9 @@ type ReceiptObj = {
         [key: string]: string;
     };
     additionalInfo: string;
+    isRefund?: boolean;
+    originalReceiptNumber?: string | null;
+    originalReceiptLabel?: string;
 } & ReceiptLabelsAndPaymentTerminalInfo;
 type ReceiptLog = {
     createdAtTimestamp: number;

package/package.json

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