rerobe-js-orm 4.9.5 → 4.9.6

package/lib/helpers/ReturnPolicyHelpers.d.ts

@@ -17,13 +17,16 @@ export default class ReturnPolicyHelpers {
         withinWindow: string;
     };
     private static normChannel;
+    private static effectiveWindowDays;
     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 getEffectiveWindowDays(raw: any, salesChannel: string): number;
     static getReturnWindowEndMillis(raw: any, salesChannel: string, soldAtMillis: number): number | null;
+    static getPayoutClearanceMillis(raw: any, salesChannel: string, soldAtMillis: number): number | null;
     static evaluateReturn({ raw, salesChannel, soldAtMillis, nowMillis, }: {
         raw: any;
         salesChannel: string;

package/lib/helpers/ReturnPolicyHelpers.js

@@ -36,10 +36,20 @@ class ReturnPolicyHelpers {
             return { allowed: false, returnPeriodDays: 0 };
         }
         const days = Number(ch.returnPeriodDays);
-        return {
+        const buffer = Number(ch.bufferDays);
+        const out = {
             allowed: ch.allowed !== false,
             returnPeriodDays: days > 0 ? Math.floor(days) : 0,
         };
+        // Only persist a buffer when set, so existing no-buffer policies serialize
+        // (and compare) unchanged.
+        if (buffer > 0)
+            out.bufferDays = Math.floor(buffer);
+        return out;
+    }
+    // Total payout-hold days for a channel = nominal return period + buffer.
+    static effectiveWindowDays(channel) {
+        return (channel.returnPeriodDays || 0) + (channel.bufferDays || 0);
     }
     // Parse a raw stored value into a structured ReturnPolicy, or null when the
     // merchant has not configured a (structured) policy. Returns null for:
@@ -102,6 +112,14 @@ class ReturnPolicyHelpers {
     }
     // 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).
+    // Effective window length (days) for a sale's channel, including the buffer.
+    // 0 when the channel has no allowed window.
+    static getEffectiveWindowDays(raw, salesChannel) {
+        const channel = this.getChannelPolicy(raw, salesChannel);
+        if (!channel || !channel.allowed || channel.returnPeriodDays <= 0)
+            return 0;
+        return this.effectiveWindowDays(channel);
+    }
     static getReturnWindowEndMillis(raw, salesChannel, soldAtMillis) {
         const channel = this.getChannelPolicy(raw, salesChannel);
         if (!channel || !channel.allowed || channel.returnPeriodDays <= 0)
@@ -109,7 +127,13 @@ class ReturnPolicyHelpers {
         const soldAt = Number(soldAtMillis);
         if (!(soldAt > 0))
             return null;
-        return soldAt + channel.returnPeriodDays * MS_PER_DAY;
+        return soldAt + this.effectiveWindowDays(channel) * MS_PER_DAY;
+    }
+    // The instant (ms) the seller payout becomes safe to release for a windowed
+    // SOLD item — return period + buffer from the sale. Same value as the window
+    // end; named for the payout-clearance caller. Null when there's no window.
+    static getPayoutClearanceMillis(raw, salesChannel, soldAtMillis) {
+        return this.getReturnWindowEndMillis(raw, salesChannel, soldAtMillis);
     }
     // Evaluate whether a return/refund should be permitted under the policy.
     // Conservative by design: when nothing is configured (no policy, unmapped
@@ -133,7 +157,7 @@ class ReturnPolicyHelpers {
         const soldAt = Number(soldAtMillis);
         if (!(soldAt > 0))
             return { allowed: true, reason: REASONS.noSoldTimestamp };
-        const windowEndMillis = soldAt + channel.returnPeriodDays * MS_PER_DAY;
+        const windowEndMillis = soldAt + this.effectiveWindowDays(channel) * MS_PER_DAY;
         const now = Number(nowMillis) > 0 ? Number(nowMillis) : Date.now();
         if (now <= windowEndMillis)
             return { allowed: true, reason: REASONS.withinWindow, windowEndMillis };

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

@@ -9,6 +9,7 @@ type SocialLinksType = {
 type ReturnPolicyChannel = {
     allowed: boolean;
     returnPeriodDays: number;
+    bufferDays?: number;
 };
 type ReturnPolicy = {
     IN_STORE: ReturnPolicyChannel;

package/package.json

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