rerobe-js-orm 4.4.0 → 4.4.2

package/lib/factories/Order/OrderFromFormState.js

@@ -5,7 +5,7 @@ const Order_1 = require("../../models/Order");
 const order_constants_1 = require("../../constants/order-constants");
 class OrderFromFormState extends OrderFactory_1.default {
     createOrder(fs) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y, _z, _0, _1, _2, _3, _4, _5, _6, _7;
         const currencyCode = fs.fields.currencyCode.inputValue || 'SEK';
         const customer = fs.fields.customer.selectedValue || {};
         const customerAttr = {
@@ -98,7 +98,7 @@ class OrderFromFormState extends OrderFactory_1.default {
             fulfillmentStatus: fs.fields.fulfillmentStatus.selectedValue,
             statusUrl: ((_j = fs.props) === null || _j === void 0 ? void 0 : _j.statusUrl) || '',
         };
-        const orderAttributes = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, totalPricesAttr), presentmentTotalPricesAttr), discountsAttr), shippingAndLocationAttr), customerAttr), statusesAttr), { id: ((_k = fs.props) === null || _k === void 0 ? void 0 : _k.id) || '', documentId: ((_l = fs.props) === null || _l === void 0 ? void 0 : _l.documentId) || '', name: ((_m = fs.props) === null || _m === void 0 ? void 0 : _m.name) || '', orderNumber: (_o = fs.props) === null || _o === void 0 ? void 0 : _o.orderNumber, ribbnOrderNumber: (_p = fs.props) === null || _p === void 0 ? void 0 : _p.ribbnOrderNumber, merchantId: ((_q = fs.props) === null || _q === void 0 ? void 0 : _q.merchantId) || '', currencyCode: fs.fields.currencyCode.inputValue, lineItems: fs.fields.lineItems.selectedValues || [], fulfillments: ((_r = fs.props) === null || _r === void 0 ? void 0 : _r.fulfillments) || [], refunds: ((_s = fs.props) === null || _s === void 0 ? void 0 : _s.refunds) || [], paymentType: fs.fields.paymentType.selectedValue, paymentMethod: fs.fields.paymentMethod.selectedValue || '', paymentDetails: fs.fields.paymentDetails.selectedValue || {}, notes: fs.fields.notes.inputValue || '', tags: fs.fields.tags.selectedValues || [], cancelReason: fs.fields.cancelReason.selectedValue || '', canceledAt: ((_t = fs.props) === null || _t === void 0 ? void 0 : _t.canceledAt) || '', processedAt: ((_u = fs.props) === null || _u === void 0 ? void 0 : _u.processedAt) || new Date().toUTCString(), adjustments: ((_v = fs.props) === null || _v === void 0 ? void 0 : _v.adjustments) || [], createdAtTimestamp: 0, updatedAtTimestamp: 0, createdByUserId: ((_w = fs.props) === null || _w === void 0 ? void 0 : _w.createdByUserId) || '', taxTitle: fs.fields.taxTitle.inputValue || '' }), (((_x = fs.props) === null || _x === void 0 ? void 0 : _x.zettleTransactionObj) && {
+        const orderAttributes = Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign(Object.assign({}, totalPricesAttr), presentmentTotalPricesAttr), discountsAttr), shippingAndLocationAttr), customerAttr), statusesAttr), { id: ((_k = fs.props) === null || _k === void 0 ? void 0 : _k.id) || '', documentId: ((_l = fs.props) === null || _l === void 0 ? void 0 : _l.documentId) || '', name: ((_m = fs.props) === null || _m === void 0 ? void 0 : _m.name) || '', orderNumber: (_o = fs.props) === null || _o === void 0 ? void 0 : _o.orderNumber, ribbnOrderNumber: (_p = fs.props) === null || _p === void 0 ? void 0 : _p.ribbnOrderNumber, merchantId: ((_q = fs.props) === null || _q === void 0 ? void 0 : _q.merchantId) || '', currencyCode: fs.fields.currencyCode.inputValue, lineItems: fs.fields.lineItems.selectedValues || [], fulfillments: ((_r = fs.props) === null || _r === void 0 ? void 0 : _r.fulfillments) || [], refunds: ((_s = fs.props) === null || _s === void 0 ? void 0 : _s.refunds) || [], paymentType: fs.fields.paymentType.selectedValue, paymentMethod: fs.fields.paymentMethod.selectedValue || '', paymentDetails: fs.fields.paymentDetails.selectedValue || {}, notes: fs.fields.notes.inputValue || '', tags: fs.fields.tags.selectedValues || [], cancelReason: fs.fields.cancelReason.selectedValue || '', canceledAt: ((_t = fs.props) === null || _t === void 0 ? void 0 : _t.canceledAt) || '', processedAt: ((_u = fs.props) === null || _u === void 0 ? void 0 : _u.processedAt) || new Date().toUTCString(), adjustments: ((_v = fs.props) === null || _v === void 0 ? void 0 : _v.adjustments) || [], createdAtTimestamp: 0, updatedAtTimestamp: 0, createdByUserId: ((_w = fs.props) === null || _w === void 0 ? void 0 : _w.createdByUserId) || '', taxTitle: fs.fields.taxTitle.inputValue || '' }), (((_x = fs.props) === null || _x === void 0 ? void 0 : _x.zettleTransactionObj) && {
             zettleTransactionObj: (_y = fs.props) === null || _y === void 0 ? void 0 : _y.zettleTransactionObj,
         })), (((_z = fs.props) === null || _z === void 0 ? void 0 : _z.paymentIntentObj) && {
             paymentIntentObj: (_0 = fs.props) === null || _0 === void 0 ? void 0 : _0.paymentIntentObj,
@@ -108,7 +108,7 @@ class OrderFromFormState extends OrderFactory_1.default {
             receiptLog: (_4 = fs.props) === null || _4 === void 0 ? void 0 : _4.receiptLog,
         })), (((_5 = fs.props) === null || _5 === void 0 ? void 0 : _5.channelPartnerOrderId) && {
             channelPartnerOrderId: (_6 = fs.props) === null || _6 === void 0 ? void 0 : _6.channelPartnerOrderId,
-        }));
+        })), { idempotencyKey: ((_7 = fs.props) === null || _7 === void 0 ? void 0 : _7.idempotencyKey) || '' });
         return new Order_1.default(Object.assign({}, orderAttributes));
     }
 }

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

@@ -178,6 +178,7 @@ export const productYesNoOptions: {
 export const productClassOptions: {
     label: string;
     value: string;
+    description: string;
 }[];
 export const productOptions: {
     value: string;

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

@@ -1060,16 +1060,19 @@ const productYesNoOptions = [
 exports.productYesNoOptions = productYesNoOptions;
 const productClassOptions = [
     {
-        label: 'Unique (One-of-a-kind, no variants)',
+        label: 'Unique',
         value: 'UNIQUE',
+        description: 'One-of-a-kind, no variants',
     },
     {
-        label: 'Multi (Parent with multiple variants)',
+        label: 'Multiple',
         value: 'MULTI',
+        description: 'Many duplicates of the same product (e.g., gift cards, shopping bags, etc.)',
     },
     {
-        label: 'Template (Blueprint for cloning)',
+        label: 'Template',
         value: 'TEMPLATE',
+        description: 'Blueprint for cloning a variant of the product at checkout',
     },
 ];
 exports.productClassOptions = productClassOptions;

package/lib/helpers/OrderHelpers.d.ts

@@ -54,4 +54,20 @@ export default class OrderHelpers {
         receiptNumber: string;
         additionalInfo: string;
     }): ReceiptObj;
+    /**
+     * Generates an idempotency key from a ReRobeOrderObj to prevent duplicate order creation
+     * Uses order content (lineItems, email, amount) plus a time bucket to allow legitimate
+     * reorders while preventing rapid duplicates within a short time window
+     */
+    generateIdempotencyKey(order: ReRobeOrderObj, timeBucketMinutes?: number): string;
+    /**
+     * Generates a time bucket string for idempotency key
+     * Orders within the same time bucket will have the same key component
+     */
+    private generateTimeBucket;
+    /**
+     * Generates a hash of line items to include in idempotency key
+     * Focuses on stable product identifiers and quantities
+     */
+    private generateLineItemsHash;
 }

package/lib/helpers/OrderHelpers.js

@@ -4,6 +4,7 @@ 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");
+const crypto_1 = require("crypto");
 class OrderHelpers {
     getOrderIdFromShopifyObj(order) {
         const { id, tags } = order;
@@ -691,5 +692,69 @@ class OrderHelpers {
                 fractionDigits: 2,
             }), taxRates: formattedTaxRates }, paymentTerminalInfo), receiptLabels);
     }
+    /**
+     * Generates an idempotency key from a ReRobeOrderObj to prevent duplicate order creation
+     * Uses order content (lineItems, email, amount) plus a time bucket to allow legitimate
+     * reorders while preventing rapid duplicates within a short time window
+     */
+    generateIdempotencyKey(order, timeBucketMinutes = 5) {
+        var _a;
+        // Financial fingerprint - core of the order
+        const totalAmount = ((_a = order.totalPrice) === null || _a === void 0 ? void 0 : _a.amount) || '0';
+        const currencyCode = order.currencyCode || '';
+        // Customer identifier - who is placing the order
+        const customerEmail = order.email || '';
+        // Merchant scope - prevent cross-merchant collisions
+        const merchantId = order.merchantId || '';
+        // Time bucket - allows same order after time window but prevents rapid duplicates
+        const timeBucket = this.generateTimeBucket(order.createdAtTimestamp || Date.now(), timeBucketMinutes);
+        // Create a hash of line items - what is being ordered
+        const lineItemsHash = this.generateLineItemsHash(order.lineItems || []);
+        // Combine all fields into a consistent string
+        // Note: We explicitly exclude client-generated IDs (id, shopifyId, orderNumber)
+        // since clients control these and could bypass idempotency protection
+        const keyComponents = [customerEmail, totalAmount, currencyCode, merchantId, timeBucket, lineItemsHash];
+        // Filter out empty values and join
+        const keyString = keyComponents.filter((component) => component && String(component).trim().length > 0).join('|');
+        // Generate SHA-256 hash for consistent length and uniqueness
+        return (0, crypto_1.createHash)('sha256').update(keyString).digest('hex').substring(0, 32); // Truncate to 32 characters for manageable length
+    }
+    /**
+     * Generates a time bucket string for idempotency key
+     * Orders within the same time bucket will have the same key component
+     */
+    generateTimeBucket(timestamp, bucketMinutes) {
+        const bucketSizeMs = bucketMinutes * 60 * 1000;
+        const bucketStart = Math.floor(timestamp / bucketSizeMs) * bucketSizeMs;
+        return bucketStart.toString();
+    }
+    /**
+     * Generates a hash of line items to include in idempotency key
+     * Focuses on stable product identifiers and quantities
+     */
+    generateLineItemsHash(lineItems) {
+        if (!lineItems || lineItems.length === 0) {
+            return '';
+        }
+        // Create a normalized representation of line items
+        const normalizedItems = lineItems
+            .map((item) => {
+            var _a, _b;
+            return {
+                productId: item.productId || '',
+                shopifyProductId: item.shopifyProductId || '',
+                variantId: ((_a = item.variant) === null || _a === void 0 ? void 0 : _a.id) || '',
+                quantity: item.quantity || 0,
+                // Include price to detect any price changes
+                unitPrice: ((_b = item.originalUnitPrice) === null || _b === void 0 ? void 0 : _b.amount) || '0',
+            };
+        })
+            .sort((a, b) => {
+            // Sort by productId to ensure consistent ordering
+            return (a.productId || '').localeCompare(b.productId || '');
+        });
+        const itemsString = JSON.stringify(normalizedItems);
+        return (0, crypto_1.createHash)('md5').update(itemsString).digest('hex').substring(0, 16); // Truncate MD5 to 16 characters
+    }
 }
 exports.default = OrderHelpers;

package/lib/helpers/ReRobeProductHelpers.js

@@ -754,6 +754,7 @@ class ReRobeProductHelpers {
         };
     }
     static convertToMetaCommerceProduct(productObj, merchantObj, targetMarketTaxRate = 0) {
+        var _a;
         const { primaryDomain, currency } = merchantObj;
         const availabilityMapper = (status) => {
             if (!status)
@@ -845,6 +846,9 @@ class ReRobeProductHelpers {
             size: productObj.standardSize || productObj.size || 'unknown',
             material: this.materialCompJoinedString(productObj.materialComposition),
             age_group: ageGroupMapper(productObj.primaryAgeCategory),
+            item_group_id: Array.isArray(productObj.tags)
+                ? ((_a = productObj.tags.find((tag) => tag === null || tag === void 0 ? void 0 : tag.startsWith('item_group_id:'))) === null || _a === void 0 ? void 0 : _a.split(':')[1]) || ''
+                : '',
         };
     }
 }

package/lib/models/Order.d.ts

@@ -47,6 +47,7 @@ export default class Order extends Base {
     id: string;
     appliedDiscount: AppliedDiscount;
     documentId: string;
+    idempotencyKey: string;
     name: string;
     orderNumber: number;
     currencyCode: string;

package/lib/models/Order.js

@@ -10,6 +10,7 @@ class Order extends Base_1.default {
             amount: 0,
         };
         this.documentId = (props === null || props === void 0 ? void 0 : props.documentId) || '';
+        this.idempotencyKey = (props === null || props === void 0 ? void 0 : props.idempotencyKey) || '';
         this.name = (props === null || props === void 0 ? void 0 : props.name) || '';
         this.orderNumber = (props === null || props === void 0 ? void 0 : props.orderNumber) || 0;
         this.currencyCode = (props === null || props === void 0 ? void 0 : props.currencyCode) || 'SEK';
@@ -149,6 +150,7 @@ class Order extends Base_1.default {
         const orderObj = {
             id: this.id,
             documentId: this.documentId,
+            idempotencyKey: this.idempotencyKey,
             appliedDiscount: this.appliedDiscount,
             name: this.name,
             orderNumber: this.orderNumber,

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

@@ -87,6 +87,7 @@ type ReRobeOrderObj = {
     saleDiscount?: Money;
     additionalDiscount?: Money;
     documentId?: string;
+    idempotencyKey?: string;
     name: string;
     orderNumber: number;
     currencyCode: string;

package/package.json

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