rerobe-js-orm 3.5.9 → 3.6.1

package/lib/factories/Product/ProductFromFormState.js

@@ -14,6 +14,7 @@ class ProductFromFormState extends ProductFactory_1.default {
             coverPhotoUrl: ((_b = props.props) === null || _b === void 0 ? void 0 : _b.coverPhotoUrl) || '',
             imageUrls: ((_c = props.props) === null || _c === void 0 ? void 0 : _c.imageUrls) || [],
             price: props.fields.price.inputValue,
+            isTaxable: props.fields.isTaxable.selectedValue,
             createdAt: ((_d = props.props) === null || _d === void 0 ? void 0 : _d.createdAt) || new Date().toUTCString(),
             updatedAt: ((_e = props.props) === null || _e === void 0 ? void 0 : _e.updatedAt) || new Date().toUTCString(),
             publishedAt: ((_f = props.props) === null || _f === void 0 ? void 0 : _f.publishedAt) || new Date().toUTCString(),

package/lib/form-states/Product/ProductFormState.js

@@ -14,6 +14,7 @@ class ProductFormState extends FormState_1.default {
         this.fields.description = this.fieldFactory('textInput', 'description');
         this.fields.title = this.fieldFactory('textInput', 'title');
         this.fields.price = this.fieldFactory('textInput', 'price');
+        this.fields.isTaxable = this.fieldFactory('singleSelect', 'isTaxable', options_1.productYesNoOptions);
         this.fields.weight = this.fieldFactory('textInput', 'weight');
         this.fields.weightRange = this.fieldFactory('singleSelect', 'weightRange', options_1.productWeightRanges);
         this.fields.weightUnit = this.fieldFactory('singleSelect', 'weightUnit', options_1.weightUnits);
@@ -65,7 +66,7 @@ class ProductFormState extends FormState_1.default {
             valid: false,
             onChangeHandler: (fileArr) => this.multiSelectMediaChangeHandler('filesToUpload', fileArr),
         };
-        this.fields.isOnSale = this.fieldFactory('singleSelect', 'isOnSale', options_1.productIsOnSaleOptions);
+        this.fields.isOnSale = this.fieldFactory('singleSelect', 'isOnSale', options_1.productYesNoOptions);
         this.fields.discountType = this.fieldFactory('singleSelect', 'discountType', options_1.discountTypeOptions);
         this.fields.discountValue = this.fieldFactory('textInput', 'discountValue');
         this.fields.editorAuthorizations = this.fieldFactory('singleSelect', 'editorAuthorizations', Object.keys(new Product_1.default().toObj()).map((v) => ({ label: this.utilities.startCase(v), value: v })));
@@ -509,6 +510,11 @@ class ProductFormState extends FormState_1.default {
                 valid = true;
                 onChangeHandler = (val) => this.singleSelectChangeHandler(fieldKey, val);
             }
+            if (fieldKey === 'isTaxable') {
+                selectedValue = this.props[fieldKey] || '';
+                valid = true;
+                onChangeHandler = (val) => this.singleSelectChangeHandler(fieldKey, val);
+            }
             if (fieldKey === 'discountType') {
                 valid = true;
                 onChangeHandler = (val) => this.discountTypeChangeHandler(val);

package/lib/form-states/Product/options.d.ts

@@ -171,7 +171,7 @@ export const discountTypeOptions: {
     label: string;
     value: string;
 }[];
-export const productIsOnSaleOptions: {
+export const productYesNoOptions: {
     label: string;
     value: string;
 }[];

package/lib/form-states/Product/options.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.measurementCategoryOptions = exports.minorDefectOptions = exports.majorDefectOptions = exports.productOptions = exports.productIsOnSaleOptions = exports.discountTypeOptions = exports.salesChannelOptions = exports.unisexJewelry = exports.mensJewelry = exports.jewelry = exports.unisexAccessories = exports.mensAccessories = exports.accessories = exports.unisexBags = exports.mensBags = exports.bags = exports.weightUnits = exports.productWeightRanges = exports.unisexShoes = exports.mensShoes = exports.shoes = exports.unisexClothing = exports.mensClothing = exports.clothing = exports.productCategories = exports.clothingMaterials = exports.shoeSizes = exports.jeanSizes = exports.genderOptions = exports.conditions = exports.colors = exports.brands = exports.sizeCommentOptions = exports.manClothingSizeOptions = exports.womanClothingSizeOptions = exports.clothingSizeOptions = exports.sizeOptions = exports.statusOptions = exports.publishTypeOptions = exports.availableForSaleOptions = void 0;
+exports.measurementCategoryOptions = exports.minorDefectOptions = exports.majorDefectOptions = exports.productOptions = exports.productYesNoOptions = exports.discountTypeOptions = exports.salesChannelOptions = exports.unisexJewelry = exports.mensJewelry = exports.jewelry = exports.unisexAccessories = exports.mensAccessories = exports.accessories = exports.unisexBags = exports.mensBags = exports.bags = exports.weightUnits = exports.productWeightRanges = exports.unisexShoes = exports.mensShoes = exports.shoes = exports.unisexClothing = exports.mensClothing = exports.clothing = exports.productCategories = exports.clothingMaterials = exports.shoeSizes = exports.jeanSizes = exports.genderOptions = exports.conditions = exports.colors = exports.brands = exports.sizeCommentOptions = exports.manClothingSizeOptions = exports.womanClothingSizeOptions = exports.clothingSizeOptions = exports.sizeOptions = exports.statusOptions = exports.publishTypeOptions = exports.availableForSaleOptions = void 0;
 const product_constants_1 = require("../../constants/product-constants");
 const lodash_1 = require("lodash");
 const availableForSaleOptions = [
@@ -2378,7 +2378,7 @@ const discountTypeOptions = [
     },
 ];
 exports.discountTypeOptions = discountTypeOptions;
-const productIsOnSaleOptions = [
+const productYesNoOptions = [
     {
         label: 'Yes',
         value: 'yes',
@@ -2388,7 +2388,7 @@ const productIsOnSaleOptions = [
         value: 'no',
     },
 ];
-exports.productIsOnSaleOptions = productIsOnSaleOptions;
+exports.productYesNoOptions = productYesNoOptions;
 const productOptions = [
     { value: 'size', label: 'Size' },
     { value: 'color', label: 'Color' },

package/lib/helpers/OrderHelpers.d.ts

@@ -3,7 +3,7 @@ export default class OrderHelpers {
     getShippingTypeFromShopifyObj(shippingLines: ShippingLineRest[] | null | undefined): string;
     getPaymentTypeUsingTags(tags: string | null | undefined): string | null;
     getSalesChannelUsingTags(tags: string | null | undefined): string | null;
-    buildLineItemFromProduct(product: CompleteProduct, currencyCode: string, quantity?: number): ReRobeOrderLineItem;
+    buildLineItemFromProduct(product: CompleteProduct, currencyCode: string, quantity?: number, taxProps?: RibbnTaxProps): ReRobeOrderLineItem;
     toFixedPointPrice(price: number | string): string;
     getAmountSumByField(array: OrderRefund[] | ReRobeOrderLineItem[], fieldKey: string): number;
     getOrderInfoWithRefundsAndFulfillments(order: CompleteOrder): OrderWithRefundsAndFulfillmentsInfoObj;
@@ -25,33 +25,24 @@ export default class OrderHelpers {
         additionalDiscount: number;
         currency: string;
     }): string;
-    getSubtotalWithoutSalePrice(productsFullInfoWithQuantity?: {
-        product: CompleteProduct;
-        quantity: number;
-    }[]): number;
-    getSubtotalWithSalePriceIncluded(productsFullInfoWithQuantity?: {
-        product: CompleteProduct;
-        quantity: number;
-    }[]): number;
-    getSaleDiscountAmount(productsFullInfoWithQuantity: {
-        product: CompleteProduct;
-        quantity: number;
-    }[]): number;
-    preparePresentmentData({ merchantName, merchantCurrency, presentmentCurrencyCode, productsFullInfoWithQuantity, currencyConverter, saleDiscountAmount, creditDiscountAmount, additionalDiscount, shippingPrice, subTotalWithSalePriceIncluded, totalIncludingShipping, }: {
+    getSubtotalWithoutSalePrice(productsFullInfoWithQuantity?: ProductsFullInfoWithQuantity): number;
+    getSubtotalWithSalePriceIncluded(productsFullInfoWithQuantity?: ProductsFullInfoWithQuantity): number;
+    getSaleDiscountAmount(productsFullInfoWithQuantity: ProductsFullInfoWithQuantity): number;
+    preparePresentmentData({ merchantName, merchantCurrency, presentmentCurrencyCode, productsFullInfoWithQuantity, currencyConverter, saleDiscountAmount, creditDiscountAmount, additionalDiscount, shippingPrice, itemsTax, shippingFeeTax, subTotalWithSalePriceIncluded, totalIncludingShipping, totalIncludingShippingAndTaxes, }: {
         merchantName: string;
         merchantCurrency: string;
         presentmentCurrencyCode?: string;
-        productsFullInfoWithQuantity: {
-            product: CompleteProduct;
-            quantity: number;
-        }[];
+        productsFullInfoWithQuantity: ProductsFullInfoWithQuantity;
         currencyConverter?(v: number | string, roundUpTo?: number): number;
         saleDiscountAmount: number;
         creditDiscountAmount: number;
         additionalDiscount: number;
         shippingPrice: number;
+        itemsTax: number;
+        shippingFeeTax: number;
         subTotalWithSalePriceIncluded: number;
         totalIncludingShipping: number;
+        totalIncludingShippingAndTaxes: number;
     }): {
         discountTitlePresentment: string;
         saleDiscountPresentment: {
@@ -89,6 +80,14 @@ export default class OrderHelpers {
             status?: string | undefined;
             isOnSale?: string | undefined;
             salePrice?: string | undefined;
+            presentmentTaxPrice?: Money | undefined;
+            isTaxable?: boolean | undefined;
+            taxRate?: number | undefined;
+            fromCountry?: string | undefined;
+            toCountry?: string | undefined;
+            taxAmount?: Money | undefined;
+            discountedPrice?: Money | undefined;
+            taxAmountWithDiscount?: Money | undefined;
             title: string;
             quantity: string | number;
             variant: ProductVariant | null;
@@ -109,9 +108,104 @@ export default class OrderHelpers {
             amount: string;
             currencyCode: string;
         };
+        itemsTaxPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        shippingFeeTax: {
+            amount: string;
+            currencyCode: string;
+        };
+        totalTaxPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
         totalPricePresentment: {
             amount: string;
             currencyCode: string;
         };
+        shippingFeeTaxPresentment?: undefined;
+    } | {
+        discountTitlePresentment: string;
+        lineItems: {
+            presentmentTotalPrice: {
+                amount: string;
+                currencyCode: string;
+            };
+            presentmentUnitPrice: {
+                amount: string;
+                currencyCode: string;
+            };
+            presentmentSalePrice: {
+                amount: string;
+                currencyCode: string;
+            };
+            brand?: string | null | undefined;
+            productId?: string | null | undefined;
+            shopifyProductId?: string | number | null | undefined;
+            refundedQuantity?: string | number | undefined;
+            canceledQuantity?: string | number | undefined;
+            fulfilledQuantity?: string | number | undefined;
+            unfulfilledQuantity?: string | number | undefined;
+            status?: string | undefined;
+            isOnSale?: string | undefined;
+            salePrice?: string | undefined;
+            presentmentTaxPrice?: Money | undefined;
+            isTaxable?: boolean | undefined;
+            taxRate?: number | undefined;
+            fromCountry?: string | undefined;
+            toCountry?: string | undefined;
+            taxAmount?: Money | undefined;
+            discountedPrice?: Money | undefined;
+            taxAmountWithDiscount?: Money | undefined;
+            title: string;
+            quantity: string | number;
+            variant: ProductVariant | null;
+            originalTotalPrice?: Money | undefined;
+            originalUnitPrice?: Money | undefined;
+            discountedTotalPrice?: Money | undefined;
+            image?: Image | undefined;
+        }[];
+        saleDiscountPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        creditDiscountPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        additionalDiscountPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        subtotalPricePresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        totalDiscountPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        totalShippingPricePresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        totalPricePresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        itemsTaxPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        shippingFeeTaxPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        totalTaxPresentment: {
+            amount: string;
+            currencyCode: string;
+        };
+        shippingFeeTax?: undefined;
     };
 }

package/lib/helpers/OrderHelpers.js

@@ -62,8 +62,17 @@ class OrderHelpers {
         }
         return null;
     }
-    buildLineItemFromProduct(product, currencyCode, quantity = 1) {
+    buildLineItemFromProduct(product, currencyCode, quantity = 1, taxProps = {}) {
         const q = quantity || 1;
+        const getImgSrc = () => {
+            if (product.imageUrls && !!product.imageUrls.length) {
+                return product.imageUrls[0];
+            }
+            if (product.sellRequestImageUrls && !!product.sellRequestImageUrls.length) {
+                return product.sellRequestImageUrls[0];
+            }
+            return '';
+        };
         return {
             title: product.title,
             quantity: q,
@@ -80,13 +89,29 @@ class OrderHelpers {
                 currencyCode,
             },
             image: {
-                originalSrc: product.imageUrls && !!product.imageUrls.length ? product.imageUrls[0] : '',
+                originalSrc: getImgSrc(),
             },
             shopifyProductId: product.shopifyId || null,
             productId: product.documentId,
             status: product.status || '',
             isOnSale: product.isOnSale === 'yes' && product.clearanceTimestamp ? 'yes' : '',
             salePrice: product.salePrice || '',
+            isTaxable: Boolean((taxProps === null || taxProps === void 0 ? void 0 : taxProps.isTaxable) || ''),
+            taxAmount: {
+                amount: Number(Number((taxProps === null || taxProps === void 0 ? void 0 : taxProps.taxAmount) || 0).toFixed(2)),
+                currencyCode,
+            },
+            taxRate: (taxProps === null || taxProps === void 0 ? void 0 : taxProps.taxRate) || 0,
+            fromCountry: (taxProps === null || taxProps === void 0 ? void 0 : taxProps.fromCountry) || '',
+            toCountry: (taxProps === null || taxProps === void 0 ? void 0 : taxProps.toCountry) || '',
+            discountedPrice: {
+                amount: Number(Number((taxProps === null || taxProps === void 0 ? void 0 : taxProps.discountedPrice) || product.price).toFixed(2)),
+                currencyCode,
+            },
+            taxAmountWithDiscount: {
+                amount: Number(Number((taxProps === null || taxProps === void 0 ? void 0 : taxProps.taxAmountWithDiscount) || 0).toFixed(2)),
+                currencyCode,
+            },
         };
     }
     toFixedPointPrice(price) {
@@ -346,16 +371,26 @@ class OrderHelpers {
         })
             .reduce((a, b) => a + b, 0);
     }
-    preparePresentmentData({ merchantName, merchantCurrency, presentmentCurrencyCode = '', productsFullInfoWithQuantity, currencyConverter = (v) => Number(v), saleDiscountAmount, creditDiscountAmount, additionalDiscount, shippingPrice, subTotalWithSalePriceIncluded, totalIncludingShipping, }) {
+    preparePresentmentData({ merchantName, merchantCurrency, presentmentCurrencyCode = '', productsFullInfoWithQuantity, currencyConverter = (v) => Number(v), saleDiscountAmount, creditDiscountAmount, additionalDiscount, shippingPrice, itemsTax, shippingFeeTax, subTotalWithSalePriceIncluded, totalIncludingShipping, totalIncludingShippingAndTaxes, }) {
         const convertAndFixPrice = (v, roundUpTo = 1) => this.toFixedPointPrice(currencyConverter(Number(this.toFixedPointPrice(v || 0)), roundUpTo));
         const prepareMoneyObj = (amount) => ({
             amount: this.toFixedPointPrice(amount),
             currencyCode: presentmentCurrencyCode || merchantCurrency,
         });
         let subtotalOriginalPresentment = 0;
+        const totalTax = Number(itemsTax || 0) + Number(shippingFeeTax || 0);
         const lineItems = productsFullInfoWithQuantity.map((item) => {
             var _a;
-            const lineItem = this.buildLineItemFromProduct(item.product, merchantCurrency, item.quantity);
+            const lineItem = this.buildLineItemFromProduct(item.product, merchantCurrency, item.quantity, {
+                price: item.price,
+                isTaxable: item.isTaxable,
+                taxAmount: item.taxAmount,
+                taxRate: item.taxRate,
+                fromCountry: item.fromCountry,
+                toCountry: item.toCountry,
+                discountedPrice: item.discountedPrice,
+                taxAmountWithDiscount: item.taxAmountWithDiscount,
+            });
             const presentmentUnitPrice = convertAndFixPrice((_a = lineItem.originalUnitPrice) === null || _a === void 0 ? void 0 : _a.amount, 5);
             const presentmentSalePrice = convertAndFixPrice(lineItem.salePrice, 5);
             const presentmentItemPrice = lineItem.isOnSale === 'yes' ? presentmentSalePrice : presentmentUnitPrice;
@@ -379,7 +414,10 @@ class OrderHelpers {
                 subtotalPricePresentment: prepareMoneyObj(subTotalWithSalePriceIncluded - creditDiscountAmount - additionalDiscount),
                 totalDiscountPresentment: prepareMoneyObj(creditDiscountAmount + additionalDiscount),
                 totalShippingPricePresentment: prepareMoneyObj(shippingPrice),
-                totalPricePresentment: prepareMoneyObj(totalIncludingShipping),
+                itemsTaxPresentment: prepareMoneyObj(itemsTax),
+                shippingFeeTax: prepareMoneyObj(shippingFeeTax),
+                totalTaxPresentment: prepareMoneyObj(totalTax),
+                totalPricePresentment: prepareMoneyObj(totalIncludingShippingAndTaxes || totalIncludingShipping),
             };
         }
         const subtotalPricePresentmentWithSalePrice = lineItems
@@ -389,6 +427,9 @@ class OrderHelpers {
         const creditDiscountPresentmentAmount = convertAndFixPrice(creditDiscountAmount || 0);
         const additionalDiscountPresentmentAmount = convertAndFixPrice(additionalDiscount || 0);
         const totalShippingPricePresentmentAmount = convertAndFixPrice(shippingPrice || 0);
+        const itemsTaxPresentmentAmount = convertAndFixPrice(itemsTax || 0);
+        const shippingFeeTaxPresentmentAmount = convertAndFixPrice(shippingFeeTax || 0);
+        const totalTaxPresentmentAmount = convertAndFixPrice(totalTax || 0);
         let subtotalPricePresentmentAmount = subtotalPricePresentmentWithSalePrice -
             Number(creditDiscountPresentmentAmount) -
             Number(additionalDiscountPresentmentAmount);
@@ -413,7 +454,12 @@ class OrderHelpers {
             subtotalPricePresentment: prepareMoneyObj(subtotalPricePresentmentAmount),
             totalDiscountPresentment: prepareMoneyObj(Number(creditDiscountPresentmentAmount) + Number(additionalDiscountPresentmentAmount)),
             totalShippingPricePresentment: prepareMoneyObj(totalShippingPricePresentmentAmount),
-            totalPricePresentment: prepareMoneyObj(Number(subtotalPricePresentmentAmount) + Number(totalShippingPricePresentmentAmount)),
+            totalPricePresentment: prepareMoneyObj(Number(subtotalPricePresentmentAmount) +
+                Number(totalShippingPricePresentmentAmount) +
+                Number(totalTaxPresentmentAmount)),
+            itemsTaxPresentment: prepareMoneyObj(itemsTaxPresentmentAmount),
+            shippingFeeTaxPresentment: prepareMoneyObj(shippingFeeTaxPresentmentAmount),
+            totalTaxPresentment: prepareMoneyObj(totalTaxPresentmentAmount),
         };
     }
 }

package/lib/models/Product.js

@@ -37,6 +37,7 @@ class Product extends Base_1.default {
             sku: (props === null || props === void 0 ? void 0 : props.sku) || '',
             metaDataTitle: (props === null || props === void 0 ? void 0 : props.metaDataTitle) || '',
             metaDataDescription: (props === null || props === void 0 ? void 0 : props.metaDataDescription) || '',
+            isTaxable: (props === null || props === void 0 ? void 0 : props.isTaxable) || '',
         };
         this.filterAttributes = {
             documentId: (props === null || props === void 0 ? void 0 : props.documentId) || this.utilities.makeRandId(28),
@@ -287,6 +288,7 @@ class Product extends Base_1.default {
             featuredCollections: this.utilities.sanitzeStringArr(this.filterAttributes.featuredCollections),
             primaryAgeCategory: this.utilities.sanitizeString(this.filterAttributes.primaryAgeCategory),
             isOnSale: this.utilities.sanitizeString(this.consignmentAttributes.isOnSale),
+            isTaxable: this.utilities.sanitizeString(this.attributes.isTaxable),
             merchants: this.utilities.sanitzeStringArr(this.attributes.merchants),
             merchantId: this.utilities.sanitizeString(this.attributes.merchantId),
             price: this.utilities.sanitizeNumber(this.attributes.price),
@@ -629,6 +631,12 @@ class Product extends Base_1.default {
                     name: 'isOnSale',
                     type: 'string',
                 },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'isTaxable',
+                    type: 'string',
+                },
                 {
                     facet: false,
                     optional: false,

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

@@ -228,6 +228,21 @@ type MoneyBag = {
     shopMoney: Money;
     presentmentMoney?: Money;
 };
+type RibbnTaxProps = {
+    price?: number;
+    isTaxable?: boolean;
+    taxAmount?: number;
+    taxRate?: number;
+    fromCountry?: string;
+    toCountry?: string;
+    discountedPrice?: number;
+    taxAmountWithDiscount?: number;
+};
+type ProductsFullInfoWithQuantity = ({
+    product: CompleteProduct;
+    quantity: number;
+    price?: number;
+} & RibbnTaxProps)[];
 interface OrderLineItem {
     title: string;
     quantity: number | string;
@@ -251,6 +266,14 @@ interface ReRobeOrderLineItem extends OrderLineItem {
     presentmentTotalPrice?: Money;
     presentmentUnitPrice?: Money;
     presentmentSalePrice?: Money;
+    presentmentTaxPrice?: Money;
+    isTaxable?: boolean;
+    taxRate?: number;
+    fromCountry?: string;
+    toCountry?: string;
+    taxAmount?: Money;
+    discountedPrice?: Money;
+    taxAmountWithDiscount?: Money;
 }
 type OrderLineItemConnection = {
     edges: OrderLineItemEdge[];

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

@@ -28,6 +28,7 @@ type ProductAttributes = {
     sku?: string;
     metaDataTitle?: string;
     metaDataDescription?: string;
+    isTaxable?: string;
 };
 type ProductFilterAttributes = {
     documentId: string;
@@ -166,6 +167,7 @@ type ProductAttributesFormFields = {
     metaDataTitle: TextInputFormField<string>;
     metaDataDescription: TextInputFormField<string>;
     handle: TextInputFormField<string>;
+    isTaxable: SingleSelectFormField<string>;
 };
 type ProductFilterAttributesFormFields = {
     brand: SingleSelectFormField<string>;
@@ -259,6 +261,7 @@ type TypesenseProductObj = {
     featuredCollections: string[];
     primaryAgeCategory: string;
     isOnSale: string;
+    isTaxable: string;
     merchants: string[];
     merchantId: string;
     price: number;

package/package.json

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