washday-sdk 0.0.8 → 0.0.10

package/src/interfaces/StoreImage.ts

@@ -1,9 +1,9 @@
-import { IUser } from "./User"
-
-export interface IStoreImage {
-    resourceUrl?: string,
-    name: string,
-    description?: string,
-    createdBy: IUser | string,
-    createdDate: Date,
-}
+import { IUser } from "./User"
+
+export interface IStoreImage {
+    resourceUrl?: string,
+    name: string,
+    description?: string,
+    createdBy: IUser | string,
+    createdDate: Date,
+}

package/src/interfaces/User.ts

@@ -1,43 +1,43 @@
-import { IPermission } from "./Permission";
-import { ICashierBox, IStore } from "./Store";
-
-interface IPrinterConfig {
-    name: String;
-    paperSize: String;
-}
-export interface IUser {
-    email: string
-    name: string
-    password: string
-    roleNum: number,
-    languagePreference?: string
-    phoneNumber: string,
-    roleChanged: boolean,
-    lastLogonDate: Date,
-    freshChatRestoreID: String,
-    permission: IPermission,
-    isActive: boolean,
-    verified: boolean,
-    cashierBox?: ICashierBox | string | null,
-    printer?: IPrinterConfig,
-}
-
-export interface ISecretCode {
-    email: string
-    code: string
-    dateCreated: Date,
-}
-
-export interface IStoreAdmin extends IUser {
-}
-
-export interface ISuperAdmin extends IUser {
-    // company: ICompany | string,
-    hasMultiStore: boolean,
-    stripeCustomerId: string,
-}
-
-export interface IStaff extends IUser {
-    store: IStore | string,
-    cashierBox: ICashierBox | string,
+import { IPermission } from "./Permission";
+import { ICashierBox, IStore } from "./Store";
+
+interface IPrinterConfig {
+    name: String;
+    paperSize: String;
+}
+export interface IUser {
+    email: string
+    name: string
+    password: string
+    roleNum: number,
+    languagePreference?: string
+    phoneNumber: string,
+    roleChanged: boolean,
+    lastLogonDate: Date,
+    freshChatRestoreID: String,
+    permission: IPermission,
+    isActive: boolean,
+    verified: boolean,
+    cashierBox?: ICashierBox | string | null,
+    printer?: IPrinterConfig,
+}
+
+export interface ISecretCode {
+    email: string
+    code: string
+    dateCreated: Date,
+}
+
+export interface IStoreAdmin extends IUser {
+}
+
+export interface ISuperAdmin extends IUser {
+    // company: ICompany | string,
+    hasMultiStore: boolean,
+    stripeCustomerId: string,
+}
+
+export interface IStaff extends IUser {
+    store: IStore | string,
+    cashierBox: ICashierBox | string,
 }

package/src/utils/index.ts

@@ -1 +1 @@
-export * from './orders';
+export * from './orders';

package/src/utils/orders/calculateOrderTotal.test.js

@@ -0,0 +1,399 @@
+// myModule.test.js
+import { calculateOrderTotal } from "./index";
+
+describe("sum function", () => {
+  const ORDER_DEMO = {
+    orderDto: {
+      deliveryDateFormatted: "lunes 08 abr.",
+      pickupInfo: null,
+      deliveryInfo: {
+        date: "2024-04-09T05:00:00.000Z",
+        fromTime: "2024-04-08T21:00:00.000Z",
+      },
+      express: false,
+      products: [
+        {
+          extraAmount: 0,
+          type: "weight",
+          showInApp: true,
+          order: 0,
+          invoice_description: "",
+          invoice_product_key: "",
+          invoice_product_unit_key: "",
+          invoice_product_unit_name: "",
+          productType: "storeProduct",
+          _id: "62d186387ec9330016319594",
+          name: "Lavado por kilo",
+          price: 17,
+          expressPrice: 20,
+          pieces: "1",
+          sku: "lavxkilo",
+          overlayText: "Lavado por kilo",
+          image: "6184782c3927a40018e36dea",
+          taxExemptOne: false,
+          taxExemptTwo: false,
+          taxExemptThree: false,
+          isActive: true,
+          store: "629c267812db5b001692adae",
+          owner: "629c267812db5b001692ada4",
+          productSupplies: [
+            {
+              usageAmount: 25,
+              _id: "62d6151fac2fc200166d0304",
+              supplyId: "62d35942c642440016cfcda8",
+            },
+          ],
+          __v: 1,
+          discountAmount: 0,
+          quantity: 3.7,
+          productId: "62d186387ec9330016319594",
+          qty: 3.7,
+        },
+      ],
+      taxesType: "included",
+      total: 62.9,
+      customer: "66147eecae83bb001540dd96",
+      store: "629c267812db5b001692adae",
+      paymentMethod: "delivery",
+      notifyBy: "none",
+      pickup: false,
+      delivery: false,
+      phone: "",
+      email: "",
+      address: "",
+      notes: "",
+      privateNotes: "",
+      creditApplied: 0,
+      amountPaid: 0,
+      customerInfo: {
+        password: "",
+        google: false,
+        facebook: false,
+        apple: false,
+        useStoreApp: false,
+        discount: 0,
+        credit: 0,
+        isActive: true,
+        createdDate: "2024-04-08T23:34:04.586Z",
+        stripeCustomerId: "",
+        invoiceInfo: {
+          _id: "66147eecae83bb001540dd95",
+          legal_name: "",
+          tax_system: "",
+          zipCode: "",
+        },
+        _id: "66147eecae83bb001540dd96",
+        name: "Carlos Piña 🍍",
+        phone: "",
+        address: "",
+        notes: "",
+        privateNotes: "",
+        rfc: "",
+        createdBy: "62d194d77ec933001631e831",
+        createdIn: "629c267812db5b001692adae",
+        company: "629c267712db5b001692ad9e",
+        addresses: [],
+        paymentMethods: [],
+        __v: 0,
+        title: "Carlos Piña 🍍",
+        id: "66147eecae83bb001540dd96",
+      },
+      customerName: "Carlos Piña 🍍",
+      pickingUpDateTime: null,
+      cleanedDateTime: null,
+      readyDateTime: null,
+      deliveringDateTime: null,
+      collectedDateTime: null,
+      cancelledDateTime: null,
+      paidDateTime: null,
+      status: "cleaning",
+      prepaidAmount: 0,
+      prepaidPaymentMethod: "",
+      customerDiscount: 0,
+      productTotal: 54.22,
+      taxesTotal: 8.68,
+      productTotalWithoutDiscount: 54.22,
+      totalDiscountAmount: 0,
+      shippingServiceTotal: 0,
+      discountsToApply: [],
+      usePrepaid: false,
+      cashierBox: "629c267812db5b001692adb3",
+      discountCode: "",
+      buyAndGetProducts: [],
+      deliveryRoute: null,
+      pickupRoute: null,
+      createdDate: "2024-04-08T23:34:48.950Z",
+    },
+    customer: {
+      customer: {
+        password: "",
+        google: false,
+        facebook: false,
+        apple: false,
+        useStoreApp: false,
+        discount: 0,
+        credit: 0,
+        isActive: true,
+        createdDate: "2024-04-08T23:34:04.586Z",
+        stripeCustomerId: "",
+        invoiceInfo: {
+          _id: "66147eecae83bb001540dd95",
+          legal_name: "",
+          tax_system: "",
+          zipCode: "",
+        },
+        _id: "66147eecae83bb001540dd96",
+        name: "Carlos Piña 🍍",
+        phone: "",
+        address: "",
+        notes: "",
+        privateNotes: "",
+        rfc: "",
+        createdBy: "62d194d77ec933001631e831",
+        createdIn: "629c267812db5b001692adae",
+        company: "629c267712db5b001692ad9e",
+        addresses: [],
+        paymentMethods: [],
+        __v: 0,
+      },
+    },
+    store: {
+      taxesType: "included",
+      notificationConfig: {
+        notifyOrderCreated: false,
+        notifyPickedUp: false,
+        notifyCleaned: true,
+        notifyCollected: false,
+        notifyDelivered: false,
+        notifyOwnerOnOrderCreated: false,
+        notifyEmail: "",
+        _id: "62a2d05fd0a7c800160869bc",
+      },
+      paymentConfig: {
+        defaultPaymentMethod: "delivery",
+        _id: "63650e8dcfa0e30016729776",
+      },
+      orderPageConfig: {
+        defaultDeliveryDate: "0",
+        defaultDeliveryTime: "18:00",
+        defaultNotifyMethod: "none",
+        printTicketAfterOrder: true,
+        shippingServiceCost: 0,
+        showProductSearchBarWeb: true,
+        _id: "6407b53301a1aa00141b217e",
+      },
+      _id: "629c267812db5b001692adae",
+      name: "Clean & Go",
+      phone: "9983524573",
+      inventory: [],
+      discountCodes: [
+        {
+          type: "percentage",
+          value: 14,
+          products: [
+            "62d1893f7ec933001631ab24",
+            "62d189697ec933001631acab",
+            "62d19a287ec933001632156f",
+            "62d199117ec9330016320ec0",
+            "62d198e07ec9330016320cc7",
+            "62d191d67ec933001631cd76",
+            "62d191747ec933001631c9cc",
+            "62d191ad7ec933001631cbef",
+          ],
+          applyToAllProducts: false,
+          applyOnceOnOrder: false,
+          hasUseLimit: false,
+          useLimitQty: 0,
+          usedCounter: 0,
+          onePerCustomer: true,
+          isActive: true,
+          buyAndGetConditions: [],
+          _id: "62d1ae1b7ec9330016328166",
+          name: "Anfitriones Airbnb",
+          code: "AIRBNBANF",
+          fromDate: "2022-07-01T05:00:00.000Z",
+          toDate: "2022-08-01T04:59:59.999Z",
+          fromTime: "00:00",
+          toTime: "23:59",
+          createdBy: "629c267812db5b001692ada4",
+          createdAt: "2022-07-15T18:12:43.506Z",
+          updatedAt: "2022-07-15T18:12:43.506Z",
+        },
+        {
+          type: "percentage",
+          value: 20,
+          products: [],
+          applyToAllProducts: true,
+          applyOnceOnOrder: false,
+          hasUseLimit: false,
+          useLimitQty: 0,
+          usedCounter: 0,
+          onePerCustomer: true,
+          isActive: true,
+          buyAndGetConditions: [],
+          _id: "635821305b689d0016c97f8c",
+          name: "Descuento por comentarios",
+          code: "20DESC01",
+          fromDate: "2022-01-01T05:00:00.000Z",
+          toDate: "2023-01-01T04:59:59.999Z",
+          fromTime: "00:00",
+          toTime: "23:59",
+          createdBy: "629c267812db5b001692ada4",
+          createdAt: "2022-10-25T17:47:28.314Z",
+          updatedAt: "2022-10-25T17:47:28.314Z",
+        },
+        {
+          type: "percentage",
+          value: 20,
+          products: [],
+          applyToAllProducts: true,
+          applyOnceOnOrder: false,
+          hasUseLimit: false,
+          useLimitQty: 0,
+          usedCounter: 0,
+          onePerCustomer: true,
+          isActive: true,
+          buyAndGetConditions: [],
+          _id: "6359c5d21332cf00168c5008",
+          name: "Descuento por comentario",
+          code: "20DESC02",
+          fromDate: "2022-01-01T05:00:00.000Z",
+          toDate: "2023-01-01T04:59:59.999Z",
+          fromTime: "00:00",
+          toTime: "23:59",
+          createdBy: "62d194d77ec933001631e831",
+          createdAt: "2022-10-26T23:42:10.732Z",
+          updatedAt: "2022-10-26T23:42:10.732Z",
+        },
+        {
+          type: "percentage",
+          value: 19,
+          products: [],
+          applyToAllProducts: true,
+          applyOnceOnOrder: false,
+          hasUseLimit: false,
+          useLimitQty: 0,
+          usedCounter: 0,
+          onePerCustomer: true,
+          isActive: true,
+          buyAndGetConditions: [],
+          _id: "6359c5ef1332cf00168c516d",
+          name: "Descuento por comentario",
+          code: "20DESC03",
+          fromDate: "2022-01-01T05:00:00.000Z",
+          toDate: "2023-01-01T04:59:59.999Z",
+          fromTime: "00:00",
+          toTime: "23:59",
+          createdBy: "62d194d77ec933001631e831",
+          createdAt: "2022-10-26T23:42:39.555Z",
+          updatedAt: "2022-10-26T23:42:39.555Z",
+        },
+        {
+          type: "percentage",
+          value: 20,
+          products: [],
+          applyToAllProducts: true,
+          applyOnceOnOrder: false,
+          hasUseLimit: false,
+          useLimitQty: 0,
+          usedCounter: 0,
+          onePerCustomer: true,
+          isActive: true,
+          buyAndGetConditions: [],
+          _id: "6359c60c1332cf00168c52c6",
+          name: "Descuento por comentario",
+          code: "20DESC04",
+          fromDate: "2022-01-01T05:00:00.000Z",
+          toDate: "2023-01-01T04:59:59.999Z",
+          fromTime: "00:00",
+          toTime: "23:59",
+          createdBy: "62d194d77ec933001631e831",
+          createdAt: "2022-10-26T23:43:08.577Z",
+          updatedAt: "2022-10-26T23:43:08.577Z",
+        },
+        {
+          type: "percentage",
+          value: 20,
+          products: [],
+          applyToAllProducts: true,
+          applyOnceOnOrder: false,
+          hasUseLimit: false,
+          useLimitQty: 0,
+          usedCounter: 0,
+          onePerCustomer: true,
+          isActive: true,
+          buyAndGetConditions: [],
+          _id: "6359c6261332cf00168c5468",
+          name: "Descuento por comentario",
+          code: "20DESC05",
+          fromDate: "2022-01-01T05:00:00.000Z",
+          toDate: "2023-01-01T04:59:59.999Z",
+          fromTime: "00:00",
+          toTime: "23:59",
+          createdBy: "62d194d77ec933001631e831",
+          createdAt: "2022-10-26T23:43:34.663Z",
+          updatedAt: "2022-10-26T23:43:34.663Z",
+        },
+      ],
+      taxOne: {
+        _id: "658bb2f376aa7b001482888c",
+        value: 16,
+        name: "IVA",
+      },
+      taxThree: null,
+      taxTwo: null,
+    },
+    hasShippingCost: false,
+    storeDiscounts: [],
+    discountCodeObj: null,
+  };
+  beforeEach(() => {
+    // Run this setup function before each test case
+  });
+  it("test calculateOrderTotal taxes included", () => {
+    // Test case
+    const {
+      orderDto,
+      customer,
+      store,
+      hasShippingCost,
+      storeDiscounts,
+      discountCodeObj,
+    } = ORDER_DEMO;
+
+    const { ...informationNewPackage } = calculateOrderTotal(
+      orderDto,
+      { customer },
+      store,
+      orderDto.delivery || orderDto.pickup,
+      // storeDiscounts.data?.discounts || [],
+      storeDiscounts,
+      discountCodeObj
+    );
+
+    const res = {
+      totalDiscountAmount: informationNewPackage.totalDiscountAmount,
+      totalQuantity: informationNewPackage.totalQuantity,
+      totalImportWithDiscount: informationNewPackage.productTotal,
+      totalImportWithoutDiscount:
+        informationNewPackage.productTotalWithoutDiscount,
+      totalImporTaxes: informationNewPackage.taxesTotal,
+      shippingCost: informationNewPackage.shippingServiceTotal,
+    };
+    expect(res).toEqual({
+      totalDiscountAmount: 0,
+      totalQuantity: 3.7,
+      totalImportWithDiscount: 54.22,
+      totalImportWithoutDiscount: 54.22,
+      totalImporTaxes: 8.68,
+      shippingCost: 0,
+    });
+  });
+
+  it("should return 0 when adding two zeros", () => {
+    // Test case
+    expect(sum(0, 0)).toBe(0);
+  });
+
+  // Add more test cases as needed
+});

package/src/utils/orders/calculateOrderTotal.ts

@@ -1,60 +1,60 @@
-import { DiscountCodeTypes } from "../../enum";
-import { ICustomer } from "../../interfaces/Customer";
-import { IStore } from "../../interfaces/Store";
-import { calculateTotalTaxesIncluded } from "./calculateTotalTaxesIncluded";
-import { calculateTotalTaxesOverPrice } from "./calculateTotalTaxesOverPrice";
-import { getCreditApplied, getProductLineTotals, getShippingCost } from "./helpers";
-
-export const calculateOrderTotal = (
-  order: any,
-  selectedCustomer: { customer: ICustomer } | undefined,
-  storeSettings: IStore,
-  hasShippingCost: boolean,
-  storeDiscounts: any[] = [],
-  discountCodeObj: any
-): any => {
-  try {
-    const appliedOrderDiscounts: any = {};
-    const productTableCalculator = storeSettings?.taxesType === 'over_price' ? calculateTotalTaxesOverPrice : calculateTotalTaxesIncluded;
-    const productTableImports = productTableCalculator(order, selectedCustomer, storeSettings, storeDiscounts, appliedOrderDiscounts, discountCodeObj);
-
-    // PRODUCT LINE TOTALS
-    const {
-      totalQuantity,
-      totalImportWithDiscount,
-      totalImportWithoutDiscount,
-      totalImporTaxes,
-      totalDiscountAmount
-    } = getProductLineTotals(productTableImports);
-
-    // DISCOUNT TOTAL AND SHIPPING SERVICE COST
-    let discountCodeAmount = 0;
-    let shippingCost = getShippingCost(discountCodeObj, hasShippingCost, storeSettings);
-
-    if (discountCodeObj && discountCodeObj.type === DiscountCodeTypes.NUMBER && discountCodeObj.applyOnceOnOrder) {
-      const includesProducts = discountCodeObj.applyToAllProducts || order.products.some((curr: any) => discountCodeObj.products.includes(curr._id));
-      discountCodeAmount = includesProducts ? discountCodeObj.value : 0;
-    }
-
-    // ORDER TOTAL CALCULATION AND CREDIT APPLIED
-    let orderTotalWithOutCredit = +(totalImportWithDiscount + totalImporTaxes + shippingCost - discountCodeAmount).toFixed(2);
-    let creditApplied = getCreditApplied(selectedCustomer, orderTotalWithOutCredit);
-    let orderTotal = +(orderTotalWithOutCredit - creditApplied).toFixed(2);
-
-    return {
-      ...order,
-      totalQuantity,
-      customerDiscount: order.discountCode ? 0 : selectedCustomer?.customer?.discount,
-      productTotal: totalImportWithDiscount,
-      taxesTotal: totalImporTaxes,
-      total: orderTotal,
-      creditApplied,
-      productTotalWithoutDiscount: totalImportWithoutDiscount,
-      totalDiscountAmount: totalDiscountAmount + discountCodeAmount,
-      shippingServiceTotal: shippingCost,
-      appliedOrderDiscounts
-    };
-  } catch (error) {
-    throw error;
-  }
-};
+import { DiscountCodeTypes } from "../../enum";
+import { ICustomer } from "../../interfaces/Customer";
+import { IStore } from "../../interfaces/Store";
+import { calculateTotalTaxesIncluded } from "./calculateTotalTaxesIncluded";
+import { calculateTotalTaxesOverPrice } from "./calculateTotalTaxesOverPrice";
+import { getCreditApplied, getProductLineTotals, getShippingCost } from "./helpers";
+
+export const calculateOrderTotal = (
+  order: any,
+  selectedCustomer: { customer: ICustomer } | undefined,
+  storeSettings: IStore,
+  hasShippingCost: boolean,
+  storeDiscounts: any[] = [],
+  discountCodeObj: any
+): any => {
+  try {
+    const appliedOrderDiscounts: any = {};
+    const productTableCalculator = storeSettings?.taxesType === 'over_price' ? calculateTotalTaxesOverPrice : calculateTotalTaxesIncluded;
+    const productTableImports = productTableCalculator(order, selectedCustomer, storeSettings, storeDiscounts, appliedOrderDiscounts, discountCodeObj);
+
+    // PRODUCT LINE TOTALS
+    const {
+      totalQuantity,
+      totalImportWithDiscount,
+      totalImportWithoutDiscount,
+      totalImporTaxes,
+      totalDiscountAmount
+    } = getProductLineTotals(productTableImports);
+
+    // DISCOUNT TOTAL AND SHIPPING SERVICE COST
+    let discountCodeAmount = 0;
+    let shippingCost = getShippingCost(discountCodeObj, hasShippingCost, storeSettings);
+
+    if (discountCodeObj && discountCodeObj.type === DiscountCodeTypes.NUMBER && discountCodeObj.applyOnceOnOrder) {
+      const includesProducts = discountCodeObj.applyToAllProducts || order.products.some((curr: any) => discountCodeObj.products.includes(curr._id));
+      discountCodeAmount = includesProducts ? discountCodeObj.value : 0;
+    }
+
+    // ORDER TOTAL CALCULATION AND CREDIT APPLIED
+    let orderTotalWithOutCredit = +(totalImportWithDiscount + totalImporTaxes + shippingCost - discountCodeAmount).toFixed(2);
+    let creditApplied = getCreditApplied(selectedCustomer, orderTotalWithOutCredit);
+    let orderTotal = +(orderTotalWithOutCredit - creditApplied).toFixed(2);
+
+    return {
+      ...order,
+      totalQuantity,
+      customerDiscount: order.discountCode ? 0 : selectedCustomer?.customer?.discount,
+      productTotal: totalImportWithDiscount,
+      taxesTotal: totalImporTaxes,
+      total: orderTotal,
+      creditApplied,
+      productTotalWithoutDiscount: totalImportWithoutDiscount,
+      totalDiscountAmount: totalDiscountAmount + discountCodeAmount,
+      shippingServiceTotal: shippingCost,
+      appliedOrderDiscounts
+    };
+  } catch (error) {
+    throw error;
+  }
+};