rerobe-js-orm 4.9.4 → 4.9.5

package/lib/factories/Merchant/MerchantFromFormState.js

@@ -22,7 +22,6 @@ class MerchantFromFormState extends MerchantFactory_1.default {
             primaryDomain: fs.fields.primaryDomain.inputValue,
             socialLinks: fs.fields.socialLinks.selectedValue,
             organizationNumber: fs.fields.organizationNumber.inputValue,
-            returnPolicy: fs.fields.returnPolicy.inputValue,
         };
         // Include organizationNumbers if it has entries
         const orgNumbers = (_a = fs.fields.organizationNumbers) === null || _a === void 0 ? void 0 : _a.selectedValue;

package/lib/form-states/Merchant/MerchantFormState.js

@@ -16,7 +16,6 @@ class MerchantFormState extends FormState_1.default {
         this.fields.legalName = this.fieldFactory('textInput', 'legalName');
         this.fields.organizationNumber = this.fieldFactory('textInput', 'organizationNumber');
         this.fields.organizationNumbers = this.fieldFactory('singleSelect', 'organizationNumbers');
-        this.fields.returnPolicy = this.fieldFactory('textInput', 'returnPolicy');
         this.fields.phone = this.fieldFactory('textInput', 'phone');
         this.fields.address = this.fieldFactory('singleSelect', 'address');
         this.fields.currency = this.fieldFactory('singleSelect', 'currency', options_1.currencyOptions);

package/lib/helpers/OrderHelpers.js

@@ -6,6 +6,7 @@ const order_constants_1 = require("../constants/order-constants");
 const translations_1 = require("../translations");
 const CryptoPolyfill_1 = require("./CryptoPolyfill");
 const PricingHelpers_1 = require("./PricingHelpers");
+const ReturnPolicyHelpers_1 = require("./ReturnPolicyHelpers");
 const MarketplaceLineDisplayHelpers_1 = require("./marketplace/MarketplaceLineDisplayHelpers");
 class OrderHelpers {
     // Frozen-rate pricing snapshot for a single order line item. Reads
@@ -594,7 +595,7 @@ class OrderHelpers {
         };
     }
     buildReceiptObjFromOrder({ order, merchant, merchantLogoUrl = '', receiptNumber = '', additionalInfo = '', isRefund = false, refundId = null, originalReceiptNumber = null, includeMarketplaceSellerPrefix = false, }) {
-        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x;
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t, _u, _v, _w, _x, _y;
         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);
@@ -691,8 +692,14 @@ class OrderHelpers {
                 translations_1.refundPurchaseTranslations[presentmentLocale] || translations_1.refundPurchaseTranslations['en-US'];
         }
         let info = additionalInfo;
-        if (returnPolicy && !isRefund) {
-            info = `${returnPolicy}`;
+        // Derive the return-policy line from the structured policy for the order's
+        // sales channel (legacy free-text policies pass through unchanged). Never
+        // shown on refund receipts.
+        const returnPolicyText = isRefund
+            ? ''
+            : ReturnPolicyHelpers_1.default.returnPolicyReceiptText(returnPolicy, (_d = order.salesChannel) !== null && _d !== void 0 ? _d : undefined);
+        if (returnPolicyText) {
+            info = returnPolicyText;
             if (additionalInfo) {
                 info = `${info}\n\n${additionalInfo}`;
             }
@@ -708,29 +715,29 @@ class OrderHelpers {
             organizationNumber,
             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: (_f = negateForRefund((_e = (_d = order.subtotalPricePresentment) === null || _d === void 0 ? void 0 : _d.amount) !== null && _e !== void 0 ? _e : '')) !== null && _f !== void 0 ? _f : '',
+                amount: (_g = negateForRefund((_f = (_e = order.subtotalPricePresentment) === null || _e === void 0 ? void 0 : _e.amount) !== null && _f !== void 0 ? _f : '')) !== null && _g !== void 0 ? _g : '',
                 fractionDigits: 2,
             }), total: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                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 : '',
+                amount: (_k = negateForRefund((_j = (_h = order.totalPricePresentment) === null || _h === void 0 ? void 0 : _h.amount) !== null && _j !== void 0 ? _j : '')) !== null && _k !== void 0 ? _k : '',
                 fractionDigits: 2,
             }), amountPaid: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                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 : '',
+                amount: (_o = negateForRefund((_m = (_l = order.totalPricePresentment) === null || _l === void 0 ? void 0 : _l.amount) !== null && _m !== void 0 ? _m : '')) !== null && _o !== void 0 ? _o : '',
                 fractionDigits: 2,
             }), tax: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                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 : '',
+                amount: (_r = negateForRefund((_q = (_p = order.totalTaxPresentment) === null || _p === void 0 ? void 0 : _p.amount) !== null && _q !== void 0 ? _q : '')) !== null && _r !== void 0 ? _r : '',
                 fractionDigits: 2,
-            }), taxRates: formattedTaxRates }, paymentTerminalInfo), receiptLabels), (Number(((_r = order.totalRefundedPresentment) === null || _r === void 0 ? void 0 : _r.amount) || 0) > 0 && {
+            }), taxRates: formattedTaxRates }, paymentTerminalInfo), receiptLabels), (Number(((_s = order.totalRefundedPresentment) === null || _s === void 0 ? void 0 : _s.amount) || 0) > 0 && {
             totalRefunded: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: (_t = (_s = order.totalRefundedPresentment) === null || _s === void 0 ? void 0 : _s.amount) !== null && _t !== void 0 ? _t : '',
+                amount: (_u = (_t = order.totalRefundedPresentment) === null || _t === void 0 ? void 0 : _t.amount) !== null && _u !== void 0 ? _u : '',
                 fractionDigits: 2,
             }),
             netPayment: (0, Utilities_1.formatPrice)({
                 currencyCode,
-                amount: Number((_v = (_u = order.totalPricePresentment) === null || _u === void 0 ? void 0 : _u.amount) !== null && _v !== void 0 ? _v : 0) - Number((_x = (_w = order.totalRefundedPresentment) === null || _w === void 0 ? void 0 : _w.amount) !== null && _x !== void 0 ? _x : 0),
+                amount: Number((_w = (_v = order.totalPricePresentment) === null || _v === void 0 ? void 0 : _v.amount) !== null && _w !== void 0 ? _w : 0) - Number((_y = (_x = order.totalRefundedPresentment) === null || _x === void 0 ? void 0 : _x.amount) !== null && _y !== void 0 ? _y : 0),
                 fractionDigits: 2,
             }),
             refundLineItems: (order.refunds || []).flatMap((refund) => (refund.refundLineItems || []).map((item) => {

package/lib/helpers/ReturnPolicyHelpers.d.ts

@@ -0,0 +1,40 @@
+type ReturnEvaluation = {
+    allowed: boolean;
+    reason: string;
+    windowEndMillis?: number;
+};
+export default class ReturnPolicyHelpers {
+    static CHANNELS: {
+        inStore: string;
+        online: string;
+    };
+    static REASONS: {
+        noPolicy: string;
+        noChannelMapping: string;
+        noSoldTimestamp: string;
+        returnsNotAllowed: string;
+        windowExpired: string;
+        withinWindow: string;
+    };
+    private static normChannel;
+    static parse(raw: any): ReturnPolicy | null;
+    static isConfigured(raw: any): boolean;
+    static defaultPolicy(): ReturnPolicy;
+    static channelKeyForSalesChannel(salesChannel: string): string | null;
+    static getChannelPolicy(raw: any, salesChannel: string): ReturnPolicyChannel | null;
+    static resolveSoldState(raw: any, salesChannel: string): string;
+    static getReturnWindowEndMillis(raw: any, salesChannel: string, soldAtMillis: number): number | null;
+    static evaluateReturn({ raw, salesChannel, soldAtMillis, nowMillis, }: {
+        raw: any;
+        salesChannel: string;
+        soldAtMillis?: number;
+        nowMillis?: number;
+    }): ReturnEvaluation;
+    static returnPolicyReceiptText(raw: any, salesChannel?: string): string;
+    static resolveEffectiveReturnPolicy({ ownPolicyRaw, marketplaceDefaultRaw, isManaged, }: {
+        ownPolicyRaw?: any;
+        marketplaceDefaultRaw?: any;
+        isManaged?: boolean;
+    }): ReturnPolicy | null;
+}
+export {};

package/lib/helpers/ReturnPolicyHelpers.js

@@ -0,0 +1,186 @@
+"use strict";
+// Return-policy business logic — the single home for everything that reads a
+// merchant's `returnPolicy`:
+//   (a) parse/normalize the stored value (tolerant of legacy free-text strings
+//       and partial/malformed objects),
+//   (b) resolve the product sold-state for a sale (drives seller-payout hold),
+//   (c) enforce the return window on a refund/return,
+//   (d) derive human-readable receipt text,
+//   (e) resolve the *effective* policy for a managed (marketplace) merchant.
+//
+// Pure + dependency-free (constants only) so backend, web, and mobile share one
+// rule instead of each reimplementing the channel join and the sold-state
+// branch. Channel keys are the RETURN_POLICY_TYPES values (IN_STORE / ONLINE);
+// SALES_CHANNEL_TO_RETURN_POLICY_MAPPING maps a sale's salesChannel onto them.
+Object.defineProperty(exports, "__esModule", { value: true });
+const product_constants_1 = require("../constants/product-constants");
+const order_constants_1 = require("../constants/order-constants");
+const MS_PER_DAY = 24 * 60 * 60 * 1000;
+// Why a refund/return was allowed or blocked. Stable strings so callers can
+// switch on them to build user-facing messages.
+const REASONS = {
+    noPolicy: 'NO_POLICY', // merchant never configured a policy -> no enforcement
+    noChannelMapping: 'NO_CHANNEL_MAPPING', // unknown sales channel -> no enforcement
+    noSoldTimestamp: 'NO_SOLD_TIMESTAMP', // can't determine sale time -> don't block
+    returnsNotAllowed: 'RETURNS_NOT_ALLOWED', // channel explicitly disallows returns
+    windowExpired: 'RETURN_WINDOW_EXPIRED', // past returnPeriodDays from the sale
+    withinWindow: 'WITHIN_WINDOW', // ok: inside the window
+};
+class ReturnPolicyHelpers {
+    // Normalize a single raw channel entry. An absent/invalid entry becomes a
+    // concrete "returns off" channel. A present object defaults `allowed` to true
+    // when the flag is missing (faithful to the legacy `allowed !== false` rule);
+    // the settings UI always writes the flag explicitly.
+    static normChannel(ch) {
+        if (!ch || typeof ch !== 'object' || Array.isArray(ch)) {
+            return { allowed: false, returnPeriodDays: 0 };
+        }
+        const days = Number(ch.returnPeriodDays);
+        return {
+            allowed: ch.allowed !== false,
+            returnPeriodDays: days > 0 ? Math.floor(days) : 0,
+        };
+    }
+    // Parse a raw stored value into a structured ReturnPolicy, or null when the
+    // merchant has not configured a (structured) policy. Returns null for:
+    // undefined/null, '', legacy free-text strings, and objects that carry
+    // neither IN_STORE nor ONLINE. Idempotent on an already-parsed policy.
+    static parse(raw) {
+        if (!raw || typeof raw !== 'object' || Array.isArray(raw)) {
+            return null;
+        }
+        const hasInStore = Object.prototype.hasOwnProperty.call(raw, order_constants_1.RETURN_POLICY_TYPES.inStore);
+        const hasOnline = Object.prototype.hasOwnProperty.call(raw, order_constants_1.RETURN_POLICY_TYPES.online);
+        if (!hasInStore && !hasOnline) {
+            return null;
+        }
+        return {
+            IN_STORE: this.normChannel(raw[order_constants_1.RETURN_POLICY_TYPES.inStore]),
+            ONLINE: this.normChannel(raw[order_constants_1.RETURN_POLICY_TYPES.online]),
+        };
+    }
+    // Is a raw value a configured (structured) policy?
+    static isConfigured(raw) {
+        return this.parse(raw) !== null;
+    }
+    // A fully-shaped "everything off" policy — a sensible starting point for the
+    // settings UI (merchant opts in per channel).
+    static defaultPolicy() {
+        return {
+            IN_STORE: { allowed: false, returnPeriodDays: 0 },
+            ONLINE: { allowed: false, returnPeriodDays: 0 },
+        };
+    }
+    // Map a sale's salesChannel to its policy channel key (IN_STORE | ONLINE), or
+    // null when the channel isn't mapped.
+    static channelKeyForSalesChannel(salesChannel) {
+        return order_constants_1.SALES_CHANNEL_TO_RETURN_POLICY_MAPPING[salesChannel] || null;
+    }
+    // The normalized channel policy that applies to a sale, or null when there's
+    // no configured policy / no channel mapping.
+    static getChannelPolicy(raw, salesChannel) {
+        const policy = this.parse(raw);
+        if (!policy)
+            return null;
+        const key = this.channelKeyForSalesChannel(salesChannel);
+        if (!key)
+            return null;
+        return policy[key] || null;
+    }
+    // Decide a sold product's state for a sale. Mirrors the legacy inline rule:
+    //   no policy / unmapped channel   -> SOLD (backwards compatible)
+    //   returns disallowed OR 0-day    -> SOLD_SELLER_PAYOUT_PROCESSING (pay now)
+    //   returns allowed WITH a window  -> SOLD (payout held through the window)
+    static resolveSoldState(raw, salesChannel) {
+        const channel = this.getChannelPolicy(raw, salesChannel);
+        if (!channel)
+            return product_constants_1.PRODUCT_STATES.sold;
+        if (!channel.allowed || channel.returnPeriodDays <= 0) {
+            return product_constants_1.PRODUCT_STATES.soldSellerPayoutProcessing;
+        }
+        return product_constants_1.PRODUCT_STATES.sold;
+    }
+    // The instant (ms) a return window closes for a sale, or null when there's no
+    // applicable window (no policy / not allowed / 0-day / no sale time).
+    static getReturnWindowEndMillis(raw, salesChannel, soldAtMillis) {
+        const channel = this.getChannelPolicy(raw, salesChannel);
+        if (!channel || !channel.allowed || channel.returnPeriodDays <= 0)
+            return null;
+        const soldAt = Number(soldAtMillis);
+        if (!(soldAt > 0))
+            return null;
+        return soldAt + channel.returnPeriodDays * MS_PER_DAY;
+    }
+    // Evaluate whether a return/refund should be permitted under the policy.
+    // Conservative by design: when nothing is configured (no policy, unmapped
+    // channel, or unknown sale time) it ALLOWS, so adding enforcement never
+    // breaks refunds for merchants who haven't opted in. It only blocks when the
+    // merchant's configured policy says so (disallowed channel or expired window).
+    static evaluateReturn({ raw, salesChannel, soldAtMillis, nowMillis, }) {
+        const policy = this.parse(raw);
+        if (!policy)
+            return { allowed: true, reason: REASONS.noPolicy };
+        const key = this.channelKeyForSalesChannel(salesChannel);
+        if (!key)
+            return { allowed: true, reason: REASONS.noChannelMapping };
+        const channel = policy[key];
+        if (!channel.allowed)
+            return { allowed: false, reason: REASONS.returnsNotAllowed };
+        if (channel.returnPeriodDays <= 0) {
+            // Allowed but no window configured -> nothing qualifies after the sale.
+            return { allowed: false, reason: REASONS.windowExpired, windowEndMillis: Number(soldAtMillis) || 0 };
+        }
+        const soldAt = Number(soldAtMillis);
+        if (!(soldAt > 0))
+            return { allowed: true, reason: REASONS.noSoldTimestamp };
+        const windowEndMillis = soldAt + channel.returnPeriodDays * MS_PER_DAY;
+        const now = Number(nowMillis) > 0 ? Number(nowMillis) : Date.now();
+        if (now <= windowEndMillis)
+            return { allowed: true, reason: REASONS.withinWindow, windowEndMillis };
+        return { allowed: false, reason: REASONS.windowExpired, windowEndMillis };
+    }
+    // Human-readable line for a receipt. Legacy free-text strings pass through
+    // unchanged. For a structured policy, prefer the sale's channel; without a
+    // channel, summarize whichever channel(s) accept returns. Returns '' when
+    // there's nothing meaningful to print (no policy, or returns not accepted).
+    static returnPolicyReceiptText(raw, salesChannel) {
+        if (typeof raw === 'string')
+            return raw.trim();
+        const policy = this.parse(raw);
+        if (!policy)
+            return '';
+        const lineFor = (ch) => {
+            if (!ch || !ch.allowed || ch.returnPeriodDays <= 0)
+                return '';
+            return `${ch.returnPeriodDays} day return policy`;
+        };
+        if (salesChannel) {
+            const key = this.channelKeyForSalesChannel(salesChannel);
+            if (key)
+                return lineFor(policy[key]);
+        }
+        const inStore = lineFor(policy.IN_STORE);
+        const online = lineFor(policy.ONLINE);
+        if (inStore && online) {
+            return inStore === online ? inStore : `In-store: ${inStore}\nOnline: ${online}`;
+        }
+        return inStore || online || '';
+    }
+    // Resolve the policy that actually governs a merchant. For a managed
+    // (marketplace) merchant the marketplace-wide default governs, falling back to
+    // the merchant's own policy only when the marketplace hasn't set one. For a
+    // standalone merchant, their own policy governs.
+    //
+    // FUTURE (per-merchant override): to let managed merchants override the
+    // marketplace default, flip the managed branch to
+    //   `this.parse(ownPolicyRaw) || this.parse(marketplaceDefaultRaw)`.
+    static resolveEffectiveReturnPolicy({ ownPolicyRaw, marketplaceDefaultRaw, isManaged, }) {
+        if (isManaged) {
+            return this.parse(marketplaceDefaultRaw) || this.parse(ownPolicyRaw);
+        }
+        return this.parse(ownPolicyRaw);
+    }
+}
+ReturnPolicyHelpers.CHANNELS = order_constants_1.RETURN_POLICY_TYPES; // { inStore: 'IN_STORE', online: 'ONLINE' }
+ReturnPolicyHelpers.REASONS = REASONS;
+exports.default = ReturnPolicyHelpers;

package/lib/index.d.ts

@@ -51,11 +51,12 @@ import TaxHelpers from './helpers/TaxHelpers';
 import PricingHelpers from './helpers/PricingHelpers';
 import ProductSkuHelpers, { DEFAULT_SKU_LENGTH, SKU_ALPHABET } from './helpers/ProductSkuHelpers';
 import ProductVariantHelpers from './helpers/ProductVariantHelpers';
+import ReturnPolicyHelpers from './helpers/ReturnPolicyHelpers';
 import ProductInventoryHelpers, { PLACEHOLDER_VARIANT_ID } from './helpers/ProductInventoryHelpers';
 import RetailProductFactory from './factories/Product/RetailProductFactory';
 import { FALLBACK_TAX_COUNTRY_CODE, TAX_CATEGORIES, TAX_CATEGORY_ALIASES, TAX_CATEGORY_BASE_LABELS, TAX_CATEGORY_RATES } from './constants/tax-constants';
 import { ADMIN_SIMPLIFIED_STATES, ADMIN_STATES, PRODUCT_CLASS_VALUES, PRODUCT_STATES, PRODUCT_STATE_LABELS, RETAIL_EDITABLE_PRODUCT_STATES, getProductStateLabel, getRetailEditableProductStateOptions } from './constants/product-constants';
-export { RibbnFile, ProductFromAlgoliaJSONDoc, ProductFromShopifyWebhookJSONDoc, ProductFromShopifyJSClientJSONDoc, ProductFormStateFactory, ProductCollectionFormStateFactory, ProductCollectionHelpers, SellRequestFormStateFactory, PickUpFormStateFactory, AddressFormStateFactory, UserFormStateFactory, UserFromShopifyWebhookJSONDoc, UserFromAuthTemplateMethod, DraftOrderFromMirakl, DraftOrderFromApp, ChatRoomFromNewUserSignUp, KlarnaSessionFactory, Product, ProductStateManager, Order, OrderFromShopifyWebhook, OrderFromShopifyAdminApi, OrderFromShopifyStorefrontApi, OrderFromApp, OrderFromTraderaEmail, OrderFormStateFactory, RefundFormStateFactory, PayoutAccount, PayoutAccountFormState, Merchant, MERCHANT_ACCOUNT_MODES, MERCHANT_ACCOUNT_CLASSES, MERCHANT_RELATIONSHIP_TYPES, MARKETPLACE_SELLER_CAPABILITIES, DEFAULT_MARKETPLACE_SELLER_CAPABILITIES, MerchantFormState, MerchantFormStateFactory, MerchantConfigAutomatedPayouts, MerchantConfigAutomatedPayoutsFormState, ReRobeProductHelpers, MarketplaceProductHelpers, MarketplaceLedgerHelpers, MarketplaceLegacyAdapters, MarketplaceLineDisplayHelpers, MarketplaceOrderHelpers, MARKETPLACE_LISTING_STATUSES, MARKETPLACE_COMMISSION_BASES, MARKETPLACE_RELATIONSHIP_TYPES, MARKETPLACE_FEE_TYPES, MARKETPLACE_FEE_ALLOCATION_BASES, MARKETPLACE_LEDGER_STATUSES, MARKETPLACE_INVENTORY_POLICY_KINDS, MARKETPLACE_SELLER_DEFAULT_COMMISSION, STOCK_STATUSES, DEFAULT_MARKETPLACE_LISTING_STATUS, DEFAULT_MARKETPLACE_COMMISSION_BASIS, DEFAULT_MARKETPLACE_RELATIONSHIP_TYPE, DEFAULT_STRIPE_FEE_ALLOCATION_BASIS, DEFAULT_RIBBN_FEE_ALLOCATION_BASIS, DEFAULT_MARKETPLACE_LEDGER_STATUS, User, AnalyticsHelpers, OrderHelpers, WebhookFormState, MerchantWebPage, ShopifyMerchantAccount, CustomerNotification, TaxHelpers, PricingHelpers, ProductSkuHelpers, ProductVariantHelpers, ProductInventoryHelpers, RetailProductFactory, SKU_ALPHABET, DEFAULT_SKU_LENGTH, PLACEHOLDER_VARIANT_ID, TAX_CATEGORIES, TAX_CATEGORY_RATES, TAX_CATEGORY_BASE_LABELS, TAX_CATEGORY_ALIASES, FALLBACK_TAX_COUNTRY_CODE, PRODUCT_STATES, PRODUCT_STATE_LABELS, PRODUCT_CLASS_VALUES, ADMIN_STATES, ADMIN_SIMPLIFIED_STATES, RETAIL_EDITABLE_PRODUCT_STATES, getProductStateLabel, getRetailEditableProductStateOptions, };
+export { RibbnFile, ProductFromAlgoliaJSONDoc, ProductFromShopifyWebhookJSONDoc, ProductFromShopifyJSClientJSONDoc, ProductFormStateFactory, ProductCollectionFormStateFactory, ProductCollectionHelpers, SellRequestFormStateFactory, PickUpFormStateFactory, AddressFormStateFactory, UserFormStateFactory, UserFromShopifyWebhookJSONDoc, UserFromAuthTemplateMethod, DraftOrderFromMirakl, DraftOrderFromApp, ChatRoomFromNewUserSignUp, KlarnaSessionFactory, Product, ProductStateManager, Order, OrderFromShopifyWebhook, OrderFromShopifyAdminApi, OrderFromShopifyStorefrontApi, OrderFromApp, OrderFromTraderaEmail, OrderFormStateFactory, RefundFormStateFactory, PayoutAccount, PayoutAccountFormState, Merchant, MERCHANT_ACCOUNT_MODES, MERCHANT_ACCOUNT_CLASSES, MERCHANT_RELATIONSHIP_TYPES, MARKETPLACE_SELLER_CAPABILITIES, DEFAULT_MARKETPLACE_SELLER_CAPABILITIES, MerchantFormState, MerchantFormStateFactory, MerchantConfigAutomatedPayouts, MerchantConfigAutomatedPayoutsFormState, ReRobeProductHelpers, MarketplaceProductHelpers, MarketplaceLedgerHelpers, MarketplaceLegacyAdapters, MarketplaceLineDisplayHelpers, MarketplaceOrderHelpers, MARKETPLACE_LISTING_STATUSES, MARKETPLACE_COMMISSION_BASES, MARKETPLACE_RELATIONSHIP_TYPES, MARKETPLACE_FEE_TYPES, MARKETPLACE_FEE_ALLOCATION_BASES, MARKETPLACE_LEDGER_STATUSES, MARKETPLACE_INVENTORY_POLICY_KINDS, MARKETPLACE_SELLER_DEFAULT_COMMISSION, STOCK_STATUSES, DEFAULT_MARKETPLACE_LISTING_STATUS, DEFAULT_MARKETPLACE_COMMISSION_BASIS, DEFAULT_MARKETPLACE_RELATIONSHIP_TYPE, DEFAULT_STRIPE_FEE_ALLOCATION_BASIS, DEFAULT_RIBBN_FEE_ALLOCATION_BASIS, DEFAULT_MARKETPLACE_LEDGER_STATUS, User, AnalyticsHelpers, OrderHelpers, WebhookFormState, MerchantWebPage, ShopifyMerchantAccount, CustomerNotification, TaxHelpers, PricingHelpers, ProductSkuHelpers, ProductVariantHelpers, ReturnPolicyHelpers, ProductInventoryHelpers, RetailProductFactory, SKU_ALPHABET, DEFAULT_SKU_LENGTH, PLACEHOLDER_VARIANT_ID, TAX_CATEGORIES, TAX_CATEGORY_RATES, TAX_CATEGORY_BASE_LABELS, TAX_CATEGORY_ALIASES, FALLBACK_TAX_COUNTRY_CODE, PRODUCT_STATES, PRODUCT_STATE_LABELS, PRODUCT_CLASS_VALUES, ADMIN_STATES, ADMIN_SIMPLIFIED_STATES, RETAIL_EDITABLE_PRODUCT_STATES, getProductStateLabel, getRetailEditableProductStateOptions, };
 export type { PlaceholderVariantInput, PlaceholderVariantInventory, PlaceholderVariantLocation, } from './helpers/ProductInventoryHelpers';
 export type { RetailOwnershipInput, RetailAccountingInput, RetailLocationInput, ClothingDetailsInput, NonClothingDetailsInput, OneOfAKindClothingInput, MultivariantClothingInput, TrackedRetailInput, UntrackedRetailInput, } from './factories/Product/RetailProductFactory';
 export type { TaxCategoryValue } from './constants/tax-constants';

package/lib/index.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.MARKETPLACE_FEE_ALLOCATION_BASES = exports.MARKETPLACE_FEE_TYPES = exports.MARKETPLACE_RELATIONSHIP_TYPES = exports.MARKETPLACE_COMMISSION_BASES = exports.MARKETPLACE_LISTING_STATUSES = exports.MarketplaceOrderHelpers = exports.MarketplaceLineDisplayHelpers = exports.MarketplaceLegacyAdapters = exports.MarketplaceLedgerHelpers = exports.MarketplaceProductHelpers = exports.ReRobeProductHelpers = exports.MerchantConfigAutomatedPayoutsFormState = exports.MerchantConfigAutomatedPayouts = exports.MerchantFormStateFactory = exports.MerchantFormState = exports.DEFAULT_MARKETPLACE_SELLER_CAPABILITIES = exports.MARKETPLACE_SELLER_CAPABILITIES = exports.MERCHANT_RELATIONSHIP_TYPES = exports.MERCHANT_ACCOUNT_CLASSES = exports.MERCHANT_ACCOUNT_MODES = exports.Merchant = exports.PayoutAccountFormState = exports.PayoutAccount = exports.RefundFormStateFactory = exports.OrderFormStateFactory = exports.OrderFromTraderaEmail = exports.OrderFromApp = exports.OrderFromShopifyStorefrontApi = exports.OrderFromShopifyAdminApi = exports.OrderFromShopifyWebhook = exports.Order = exports.ProductStateManager = exports.Product = exports.KlarnaSessionFactory = exports.ChatRoomFromNewUserSignUp = exports.DraftOrderFromApp = exports.DraftOrderFromMirakl = exports.UserFromAuthTemplateMethod = exports.UserFromShopifyWebhookJSONDoc = exports.UserFormStateFactory = exports.AddressFormStateFactory = exports.PickUpFormStateFactory = exports.SellRequestFormStateFactory = exports.ProductCollectionHelpers = exports.ProductCollectionFormStateFactory = exports.ProductFormStateFactory = exports.ProductFromShopifyJSClientJSONDoc = exports.ProductFromShopifyWebhookJSONDoc = exports.ProductFromAlgoliaJSONDoc = exports.RibbnFile = void 0;
-exports.getRetailEditableProductStateOptions = exports.getProductStateLabel = exports.RETAIL_EDITABLE_PRODUCT_STATES = exports.ADMIN_SIMPLIFIED_STATES = exports.ADMIN_STATES = exports.PRODUCT_CLASS_VALUES = exports.PRODUCT_STATE_LABELS = exports.PRODUCT_STATES = exports.FALLBACK_TAX_COUNTRY_CODE = exports.TAX_CATEGORY_ALIASES = exports.TAX_CATEGORY_BASE_LABELS = exports.TAX_CATEGORY_RATES = exports.TAX_CATEGORIES = exports.PLACEHOLDER_VARIANT_ID = exports.DEFAULT_SKU_LENGTH = exports.SKU_ALPHABET = exports.RetailProductFactory = exports.ProductInventoryHelpers = exports.ProductVariantHelpers = exports.ProductSkuHelpers = exports.PricingHelpers = exports.TaxHelpers = exports.CustomerNotification = exports.ShopifyMerchantAccount = exports.MerchantWebPage = exports.WebhookFormState = exports.OrderHelpers = exports.AnalyticsHelpers = exports.User = exports.DEFAULT_MARKETPLACE_LEDGER_STATUS = exports.DEFAULT_RIBBN_FEE_ALLOCATION_BASIS = exports.DEFAULT_STRIPE_FEE_ALLOCATION_BASIS = exports.DEFAULT_MARKETPLACE_RELATIONSHIP_TYPE = exports.DEFAULT_MARKETPLACE_COMMISSION_BASIS = exports.DEFAULT_MARKETPLACE_LISTING_STATUS = exports.STOCK_STATUSES = exports.MARKETPLACE_SELLER_DEFAULT_COMMISSION = exports.MARKETPLACE_INVENTORY_POLICY_KINDS = exports.MARKETPLACE_LEDGER_STATUSES = void 0;
+exports.getRetailEditableProductStateOptions = exports.getProductStateLabel = exports.RETAIL_EDITABLE_PRODUCT_STATES = exports.ADMIN_SIMPLIFIED_STATES = exports.ADMIN_STATES = exports.PRODUCT_CLASS_VALUES = exports.PRODUCT_STATE_LABELS = exports.PRODUCT_STATES = exports.FALLBACK_TAX_COUNTRY_CODE = exports.TAX_CATEGORY_ALIASES = exports.TAX_CATEGORY_BASE_LABELS = exports.TAX_CATEGORY_RATES = exports.TAX_CATEGORIES = exports.PLACEHOLDER_VARIANT_ID = exports.DEFAULT_SKU_LENGTH = exports.SKU_ALPHABET = exports.RetailProductFactory = exports.ProductInventoryHelpers = exports.ReturnPolicyHelpers = exports.ProductVariantHelpers = exports.ProductSkuHelpers = exports.PricingHelpers = exports.TaxHelpers = exports.CustomerNotification = exports.ShopifyMerchantAccount = exports.MerchantWebPage = exports.WebhookFormState = exports.OrderHelpers = exports.AnalyticsHelpers = exports.User = exports.DEFAULT_MARKETPLACE_LEDGER_STATUS = exports.DEFAULT_RIBBN_FEE_ALLOCATION_BASIS = exports.DEFAULT_STRIPE_FEE_ALLOCATION_BASIS = exports.DEFAULT_MARKETPLACE_RELATIONSHIP_TYPE = exports.DEFAULT_MARKETPLACE_COMMISSION_BASIS = exports.DEFAULT_MARKETPLACE_LISTING_STATUS = exports.STOCK_STATUSES = exports.MARKETPLACE_SELLER_DEFAULT_COMMISSION = exports.MARKETPLACE_INVENTORY_POLICY_KINDS = exports.MARKETPLACE_LEDGER_STATUSES = void 0;
 const ProductFromShopifyJSClientJSONDoc_1 = require("./factories/Product/ProductFromShopifyJSClientJSONDoc");
 exports.ProductFromShopifyJSClientJSONDoc = ProductFromShopifyJSClientJSONDoc_1.default;
 const ProductFromAlgoliaJSONDoc_1 = require("./factories/Product/ProductFromAlgoliaJSONDoc");
@@ -128,6 +128,8 @@ Object.defineProperty(exports, "DEFAULT_SKU_LENGTH", { enumerable: true, get: fu
 Object.defineProperty(exports, "SKU_ALPHABET", { enumerable: true, get: function () { return ProductSkuHelpers_1.SKU_ALPHABET; } });
 const ProductVariantHelpers_1 = require("./helpers/ProductVariantHelpers");
 exports.ProductVariantHelpers = ProductVariantHelpers_1.default;
+const ReturnPolicyHelpers_1 = require("./helpers/ReturnPolicyHelpers");
+exports.ReturnPolicyHelpers = ReturnPolicyHelpers_1.default;
 const ProductInventoryHelpers_1 = require("./helpers/ProductInventoryHelpers");
 exports.ProductInventoryHelpers = ProductInventoryHelpers_1.default;
 Object.defineProperty(exports, "PLACEHOLDER_VARIANT_ID", { enumerable: true, get: function () { return ProductInventoryHelpers_1.PLACEHOLDER_VARIANT_ID; } });

package/lib/models/Merchant.d.ts

@@ -190,7 +190,8 @@ export default class Merchant extends Base {
     hasStripeBluetoothReader?: boolean;
     organizationNumber?: string;
     organizationNumbers?: Record<string, string>;
-    returnPolicy?: string;
+    returnPolicy?: ReturnPolicy | string;
+    managedReturnPolicyDefault?: ReturnPolicy;
     stripeRegion?: string;
     hasAutomatedPayouts?: boolean;
     hasAIQuickList?: boolean;
@@ -210,6 +211,8 @@ export default class Merchant extends Base {
     isMarketplaceSeller?: boolean;
     constructor(props?: any);
     static normalizeLabelPrinterConfig(input?: Partial<LabelPrinterConfig> | Record<string, any> | null): LabelPrinterConfig;
+    getReturnPolicy(): ReturnPolicy | null;
+    getManagedReturnPolicyDefault(): ReturnPolicy | null;
     toObj(): MerchantObj;
     toMerchantMutableData(): MerchantMutableData;
     isManagedMarketplaceMerchant(): boolean;

package/lib/models/Merchant.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const Base_1 = require("../Base");
 const merchant_constants_1 = require("../constants/merchant-constants");
+const ReturnPolicyHelpers_1 = require("../helpers/ReturnPolicyHelpers");
 class Merchant extends Base_1.default {
     constructor(props) {
         super();
@@ -53,6 +54,9 @@ class Merchant extends Base_1.default {
             this.organizationNumbers = props.organizationNumbers;
         }
         this.returnPolicy = (props === null || props === void 0 ? void 0 : props.returnPolicy) || '';
+        if ((props === null || props === void 0 ? void 0 : props.managedReturnPolicyDefault) && typeof props.managedReturnPolicyDefault === 'object') {
+            this.managedReturnPolicyDefault = props.managedReturnPolicyDefault;
+        }
         this.subscriptionStatus = (props === null || props === void 0 ? void 0 : props.subscriptionStatus) || merchant_constants_1.SUBSCRIPTION_STATUSES.trialing;
         this.hasActiveWebshop = (props === null || props === void 0 ? void 0 : props.hasActiveWebshop) || false;
         this.accountMode = (props === null || props === void 0 ? void 0 : props.accountMode) || Merchant.MERCHANT_ACCOUNT_MODES.standalone;
@@ -167,6 +171,16 @@ class Merchant extends Base_1.default {
             layout,
         };
     }
+    // This merchant's own return policy, parsed/normalized (null when unset or a
+    // legacy free-text string). See ReturnPolicyHelpers for the resolution rules.
+    getReturnPolicy() {
+        return ReturnPolicyHelpers_1.default.parse(this.returnPolicy);
+    }
+    // The marketplace-wide default this merchant (as a marketplace/parent) applies
+    // to its managed merchants, parsed/normalized (null when unset).
+    getManagedReturnPolicyDefault() {
+        return ReturnPolicyHelpers_1.default.parse(this.managedReturnPolicyDefault);
+    }
     toObj() {
         const mObj = {
             name: this.name,
@@ -209,6 +223,9 @@ class Merchant extends Base_1.default {
         if (this.managedByMerchantId) {
             mObj.managedByMerchantId = this.managedByMerchantId;
         }
+        if (this.managedReturnPolicyDefault) {
+            mObj.managedReturnPolicyDefault = this.managedReturnPolicyDefault;
+        }
         if (typeof this.canUpgradeToStandalone === 'boolean') {
             mObj.canUpgradeToStandalone = this.canUpgradeToStandalone;
         }

package/lib/types/merchant-types.d.ts

@@ -6,6 +6,14 @@ type SocialLinksType = {
     pinterest: string;
     tiktok: string;
 };
+type ReturnPolicyChannel = {
+    allowed: boolean;
+    returnPeriodDays: number;
+};
+type ReturnPolicy = {
+    IN_STORE: ReturnPolicyChannel;
+    ONLINE: ReturnPolicyChannel;
+};
 type MerchantMutableData = {
     name: string;
     type: MerchantTypes | string;
@@ -30,7 +38,8 @@ type MerchantMutableData = {
     featureAccess?: MerchantFeatureAccess | null;
     organizationNumber?: string;
     organizationNumbers?: Record<string, string>;
-    returnPolicy?: string;
+    returnPolicy?: ReturnPolicy | string;
+    managedReturnPolicyDefault?: ReturnPolicy;
 };
 type MerchantSystemOnlyMutableData = {
     paymentTier: RibbnPaymentTiers | string;
@@ -129,7 +138,6 @@ type MerchantFormFields = {
     legalName: TextInputFormField<string>;
     organizationNumber: TextInputFormField<string>;
     organizationNumbers: SingleSelectFormField<Record<string, string>>;
-    returnPolicy: TextInputFormField<string>;
     phone: TextInputFormField<string>;
     address: SingleSelectFormField<AddressInput>;
     currency: SingleSelectFormField<string>;

package/package.json

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