rerobe-js-orm 3.7.9 → 3.8.1

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

@@ -8,6 +8,8 @@ export namespace PAYMENT_TYPES {
     const klarna: string;
     const swish: string;
     const shoppingCredit: string;
+    const cash: string;
+    const mobilePayment: string;
 }
 export namespace ORDER_STATES {
     const draft: string;

package/lib/constants/order-constants.js

@@ -11,6 +11,8 @@ exports.PAYMENT_TYPES = {
     klarna: 'KLARNA',
     swish: 'SWISH',
     shoppingCredit: 'SHOPPING_CREDIT',
+    cash: 'CASH',
+    mobilePayment: 'MOBILE_PAYMENT',
 };
 exports.ORDER_STATES = {
     draft: 'DRAFT',

package/lib/helpers/OrderHelpers.d.ts

@@ -216,34 +216,9 @@ export default class OrderHelpers {
     };
     getPaymentTerminalReceiptInfo(payload?: any): PaymentTerminalReceiptInfo;
     getFormattedFulfillmentLocation(order: ReRobeOrderObj): string;
+    generateReceiptLabels(locale: string, paymentMethod: string, entryMethod?: string): ReceiptLabels;
     buildReceiptObjFromOrder({ order, merchant }: {
         order: ReRobeOrderObj;
         merchant: MerchantObj;
-    }): {
-        aid: string;
-        tvr: string;
-        authorizationCode: string;
-        entryMode: string;
-        applicationName: string;
-        cardBrand: string;
-        lastFour: string;
-        referenceNumber: string;
-        merchantName: string;
-        storeAddress: string;
-        phone: string;
-        contactEmail: string;
-        organizationNumber: string | undefined;
-        primaryDomain: string;
-        orderDate: string;
-        lineItems: {
-            title: string;
-            price: string;
-            quantity: string | number;
-            showUnitPrice: boolean;
-            unitPrice: string;
-        }[];
-        subTotal: string;
-        amountPaid: string;
-        tax: string;
-    };
+    }): ReceiptObj;
 }

package/lib/helpers/OrderHelpers.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const Order_1 = require("../models/Order");
 const Utilities_1 = require("../helpers/Utilities");
+const order_constants_1 = require("../constants/order-constants");
+const translations_1 = require("../translations");
 class OrderHelpers {
     getOrderIdFromShopifyObj(order) {
         const { id, tags } = order;
@@ -519,13 +521,37 @@ class OrderHelpers {
         const location = (_a = fulfillmentLocations[0]) === null || _a === void 0 ? void 0 : _a.location;
         return (0, Utilities_1.convertAddressInputToFormatted)(location);
     }
+    generateReceiptLabels(locale, paymentMethod, entryMethod = '') {
+        let paymentMethodLabel = translations_1.cardPaymentTranslations[locale] || translations_1.cardPaymentTranslations['en-US'];
+        if (paymentMethod === order_constants_1.PAYMENT_TYPES.cash) {
+            paymentMethodLabel = translations_1.cashTranslations[locale] || translations_1.cashTranslations['en-US'];
+        }
+        if (paymentMethod === order_constants_1.PAYMENT_TYPES.mobilePayment) {
+            paymentMethodLabel = translations_1.mobilePaymentTranslations[locale] || translations_1.mobilePaymentTranslations['en-US'];
+        }
+        let entryMethodLabel = '';
+        const contactlessRegex = /contactless|kontaktlos|kontaktløs|kontaktlös|contact-less/i;
+        if (contactlessRegex.test(entryMethod)) {
+            entryMethodLabel = translations_1.contactlessTranslations[locale] || translations_1.contactlessTranslations['en-US'];
+        }
+        return {
+            receiptLabel: translations_1.receiptTranslations[locale] || translations_1.receiptTranslations['en-US'],
+            totalLabel: translations_1.totalTranslations[locale] || translations_1.totalTranslations['en-US'],
+            taxLabel: translations_1.taxTranslations[locale] || translations_1.taxTranslations['en-US'],
+            purchaseLabel: translations_1.purchaseTranslations[locale] || translations_1.purchaseTranslations['en-US'],
+            authorizationCodeLabel: translations_1.authorizationCodeTranslations[locale] || translations_1.authorizationCodeTranslations['en-US'],
+            referenceLabel: translations_1.referenceTranslations[locale] || translations_1.referenceTranslations['en-US'],
+            paymentMethodLabel,
+            entryMethodLabel,
+        };
+    }
     buildReceiptObjFromOrder({ order, merchant }) {
-        var _a, _b, _c, _d, _e, _f, _g;
-        const { address: merchantAddress, legalName, contactEmail, phone, organizationNumber, primaryDomain, currency: storeCurrencyCode, } = merchant;
+        var _a, _b, _c, _d, _e, _f, _g, _h;
+        const { address: merchantAddress, legalName, contactEmail, phone = '', organizationNumber = '', primaryDomain, currency: storeCurrencyCode, } = 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;
             let totalPrice = Number((_a = l.presentmentTotalPrice) === null || _a === void 0 ? void 0 : _a.amount);
             if (l.isTaxable && l.taxRate) {
                 const taxRate = Number(l.taxRate);
@@ -538,11 +564,11 @@ class OrderHelpers {
                     amount: totalPrice,
                     fractionDigits: 2,
                 }),
-                quantity: l === null || l === void 0 ? void 0 : l.quantity,
+                quantity: Number((_b = l === null || l === void 0 ? void 0 : l.quantity) !== null && _b !== void 0 ? _b : 0),
                 showUnitPrice: Number(l === null || l === void 0 ? void 0 : l.quantity) > 1,
                 unitPrice: (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: (_d = (_c = l === null || l === void 0 ? void 0 : l.originalUnitPrice) === null || _c === void 0 ? void 0 : _c.amount) !== null && _d !== void 0 ? _d : '',
                     fractionDigits: 2,
                 }),
             };
@@ -572,6 +598,27 @@ class OrderHelpers {
             }
             return result;
         };
+        const taxRates = order.lineItems
+            .map((lineItem) => {
+            var _a;
+            if (lineItem.isTaxable) {
+                return {
+                    taxRate: lineItem.taxRate,
+                    taxAmount: ((_a = lineItem.taxAmountWithDiscount) === null || _a === void 0 ? void 0 : _a.amount) || 0,
+                };
+            }
+            return {};
+        })
+            .reduce((acc, cur) => {
+            if (cur.taxRate) {
+                if (!acc[cur.taxRate]) {
+                    acc[cur.taxRate] = 0;
+                }
+                acc[cur.taxRate] += Number(cur.taxAmount);
+                acc[cur.taxRate] = parseFloat(acc[cur.taxRate].toFixed(2));
+            }
+            return acc;
+        }, {});
         const buildStoreAddress = () => {
             let address = this.getFormattedFulfillmentLocation(order);
             if (!address) {
@@ -579,22 +626,22 @@ class OrderHelpers {
             }
             return address;
         };
-        return Object.assign({ merchantName: legalName, storeAddress: buildStoreAddress(), phone,
+        const paymentMethod = (_b = order.paymentMethod) !== null && _b !== void 0 ? _b : '';
+        return Object.assign(Object.assign({ merchantName: legalName, storeAddress: buildStoreAddress(), phone,
             contactEmail,
-            organizationNumber,
-            primaryDomain, orderDate: (0, Utilities_1.getFormattedTimestamp)(presentmentLocale), lineItems: buildLineItems(), subTotal: (0, Utilities_1.formatPrice)({
+            organizationNumber, primaryDomain: `https://${primaryDomain}`, orderDate: (0, Utilities_1.getFormattedTimestamp)(presentmentLocale), lineItems: buildLineItems(), subTotal: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: (_c = (_b = order.subtotalPricePresentment) === null || _b === void 0 ? void 0 : _b.amount) !== null && _c !== void 0 ? _c : '',
+                amount: (_d = (_c = order.subtotalPricePresentment) === null || _c === void 0 ? void 0 : _c.amount) !== null && _d !== void 0 ? _d : '',
                 fractionDigits: 2,
             }), amountPaid: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: (_e = (_d = order.totalPricePresentment) === null || _d === void 0 ? void 0 : _d.amount) !== null && _e !== void 0 ? _e : '',
+                amount: (_f = (_e = order.totalPricePresentment) === null || _e === void 0 ? void 0 : _e.amount) !== null && _f !== void 0 ? _f : '',
                 fractionDigits: 2,
             }), tax: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: (_g = (_f = order.totalTaxPresentment) === null || _f === void 0 ? void 0 : _f.amount) !== null && _g !== void 0 ? _g : '',
+                amount: (_h = (_g = order.totalTaxPresentment) === null || _g === void 0 ? void 0 : _g.amount) !== null && _h !== void 0 ? _h : '',
                 fractionDigits: 2,
-            }) }, this.getPaymentTerminalReceiptInfo(order));
+            }), taxRates }, this.generateReceiptLabels(presentmentLocale, paymentMethod)), this.getPaymentTerminalReceiptInfo(order));
     }
 }
 exports.default = OrderHelpers;

package/lib/models/Order.d.ts

@@ -10,6 +10,8 @@ export default class Order extends Base {
         klarna: string;
         swish: string;
         shoppingCredit: string;
+        cash: string;
+        mobilePayment: string;
     };
     static ORDER_STATES: {
         draft: string;

package/lib/translations.d.ts

@@ -0,0 +1,30 @@
+export declare const receiptTranslations: {
+    [key: string]: string;
+};
+export declare const totalTranslations: {
+    [key: string]: string;
+};
+export declare const taxTranslations: {
+    [key: string]: string;
+};
+export declare const purchaseTranslations: {
+    [key: string]: string;
+};
+export declare const cashTranslations: {
+    [key: string]: string;
+};
+export declare const cardPaymentTranslations: {
+    [key: string]: string;
+};
+export declare const mobilePaymentTranslations: {
+    [key: string]: string;
+};
+export declare const authorizationCodeTranslations: {
+    [key: string]: string;
+};
+export declare const contactlessTranslations: {
+    [key: string]: string;
+};
+export declare const referenceTranslations: {
+    [key: string]: string;
+};

package/lib/translations.js

@@ -0,0 +1,73 @@
+"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.receiptTranslations = {
+    'sv-SE': 'Kvitto',
+    'nb-NO': 'Kvittering',
+    'en-US': 'Receipt',
+    'en-UK': 'Receipt',
+    'en-DE': 'Quittung',
+};
+exports.totalTranslations = {
+    'sv-SE': 'Totalt',
+    'nb-NO': 'Total',
+    'en-US': 'Total',
+    'en-UK': 'Total',
+    'en-DE': 'Gesamt',
+};
+exports.taxTranslations = {
+    'sv-SE': 'Moms',
+    'nb-NO': 'MVA',
+    'en-US': 'Tax',
+    'en-UK': 'Tax',
+    'en-DE': 'MwSt',
+};
+exports.purchaseTranslations = {
+    'sv-SE': 'Köp',
+    'nb-NO': 'Kjøp',
+    'en-US': 'Purchase',
+    'en-UK': 'Purchase',
+    'en-DE': 'Kauf',
+};
+exports.cashTranslations = {
+    'sv-SE': 'Kontant',
+    'nb-NO': 'Kontant',
+    'en-US': 'Cash',
+    'en-UK': 'Cash',
+    'en-DE': 'Bar',
+};
+exports.cardPaymentTranslations = {
+    'sv-SE': 'Kortbetalning',
+    'nb-NO': 'Kortbetaling',
+    'en-US': 'Card Payment',
+    'en-UK': 'Card Payment',
+    'en-DE': 'Kartenzahlung',
+};
+exports.mobilePaymentTranslations = {
+    'sv-SE': 'Swish',
+    'nb-NO': 'Vipps',
+    'en-US': 'Mobile Payment',
+    'en-UK': 'Mobile Payment',
+    'en-DE': 'Mobiles Bezahlen',
+};
+exports.authorizationCodeTranslations = {
+    'sv-SE': 'Auktoriseringskod',
+    'nb-NO': 'Autorisasjonskode',
+    'en-US': 'Authorization Code',
+    'en-UK': 'Authorization Code',
+    'en-DE': 'Autorisierungscode',
+};
+exports.contactlessTranslations = {
+    'sv-SE': 'Kontaktlös',
+    'nb-NO': 'Kontaktløs',
+    'en-US': 'Contactless',
+    'en-UK': 'Contactless',
+    'en-DE': 'Kontaktlos',
+};
+exports.referenceTranslations = {
+    'sv-SE': 'Referens',
+    'nb-NO': 'Referanse',
+    'en-US': 'Reference',
+    'en-UK': 'Reference',
+    'en-DE': 'Referenz',
+};

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

@@ -39,6 +39,40 @@ interface PaymentTerminalReceiptInfo {
     lastFour: string;
     referenceNumber: string;
 }
+type ReceiptLineItem = {
+    title: string;
+    price: string;
+    showUnitPrice: boolean;
+    quantity: number;
+    unitPrice: string;
+};
+interface ReceiptLabels {
+    receiptLabel: string;
+    totalLabel: string;
+    taxLabel: string;
+    purchaseLabel: string;
+    paymentMethodLabel: string;
+    entryMethodLabel: string;
+    authorizationCodeLabel: string;
+    referenceLabel: string;
+}
+type ReceiptLabelsAndPaymentTerminalInfo = ReceiptLabels & PaymentTerminalReceiptInfo;
+interface ReceiptObj extends ReceiptLabelsAndPaymentTerminalInfo {
+    merchantName: string;
+    storeAddress: string;
+    phone: string;
+    contactEmail: string;
+    organizationNumber: string;
+    primaryDomain: string;
+    orderDate: string;
+    lineItems: ReceiptLineItem[];
+    subTotal: string;
+    amountPaid: string;
+    tax: string;
+    taxRates: {
+        [key: number]: number;
+    };
+}
 type ReRobeOrderObj = {
     id: string;
     appliedDiscount: AppliedDiscount;

package/package.json

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