@riocrypto/common 1.0.2670 → 1.0.2673

package/build/events/user-updated-event.d.ts

@@ -2,7 +2,7 @@ import { Country } from "../types/country";
 import { CountryOfOrigin } from "../types/country-of-origin";
 import { MexicoInvoicingMethod } from "../types/mexico-invoicing-method";
 import { OnboardingStatus } from "../types/onboarding-status";
-import { PlatformFeeRange } from "../types/platform-fee-range";
+import { PlatformFeesForCountry } from "../types/platform-fee-range";
 import { UserAttribute } from "../types/user-attribute";
 import { Subjects } from "./subjects";
 export interface UserUpdatedEvent {
@@ -18,18 +18,9 @@ export interface UserUpdatedEvent {
         authorizedPhoneNumbers?: string[];
         quotationTime?: number;
         platformFeeRanges?: {
-            MX?: {
-                buy?: PlatformFeeRange[];
-                sell?: PlatformFeeRange[];
-            };
-            PE?: {
-                buy?: PlatformFeeRange[];
-                sell?: PlatformFeeRange[];
-            };
-            CO?: {
-                buy?: PlatformFeeRange[];
-                sell?: PlatformFeeRange[];
-            };
+            MX?: PlatformFeesForCountry;
+            PE?: PlatformFeesForCountry;
+            CO?: PlatformFeesForCountry;
         };
         onboarding?: {
             country?: Country;

package/build/helpers/find-platform-fee-range-conflict.d.ts

@@ -0,0 +1,13 @@
+import { PlatformFeeRange } from "../types/platform-fee-range";
+/**
+ * Returns the first pair of ranges (indices into `ranges`) that could
+ * both apply to the same order — i.e. their amount ranges intersect and
+ * their schedules can be simultaneously active — or undefined if the
+ * set is conflict-free. Used on both the dashboard and the users
+ * service so that fee resolution is always unambiguous: at any moment
+ * and any amount, at most one range matches.
+ */
+export declare const findPlatformFeeRangeConflict: (ranges: PlatformFeeRange[]) => {
+    firstIndex: number;
+    secondIndex: number;
+} | undefined;

package/build/helpers/find-platform-fee-range-conflict.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findPlatformFeeRangeConflict = void 0;
+const schedulesShareTime = (a, b) => {
+    // An unscheduled range applies at all times, so it shares time with
+    // everything.
+    if (!a || !a.daysOfWeek || a.daysOfWeek.length === 0)
+        return true;
+    if (!b || !b.daysOfWeek || b.daysOfWeek.length === 0)
+        return true;
+    const shareDay = a.daysOfWeek.some((day) => b.daysOfWeek.includes(day));
+    if (!shareDay)
+        return false;
+    return a.startMinute < b.endMinute && b.startMinute < a.endMinute;
+};
+// Strict interior overlap: existing ladders share single boundary
+// points (e.g. $0-100k followed by $100k-10M), which lookup resolves by
+// first match, so touching endpoints are not treated as a conflict.
+const rangesShareAmounts = (a, b) => a.min < b.max && b.min < a.max;
+/**
+ * Returns the first pair of ranges (indices into `ranges`) that could
+ * both apply to the same order — i.e. their amount ranges intersect and
+ * their schedules can be simultaneously active — or undefined if the
+ * set is conflict-free. Used on both the dashboard and the users
+ * service so that fee resolution is always unambiguous: at any moment
+ * and any amount, at most one range matches.
+ */
+const findPlatformFeeRangeConflict = (ranges) => {
+    for (let i = 0; i < ranges.length; i++) {
+        for (let j = i + 1; j < ranges.length; j++) {
+            if (rangesShareAmounts(ranges[i], ranges[j]) &&
+                schedulesShareTime(ranges[i].schedule, ranges[j].schedule)) {
+                return { firstIndex: i, secondIndex: j };
+            }
+        }
+    }
+    return undefined;
+};
+exports.findPlatformFeeRangeConflict = findPlatformFeeRangeConflict;

package/build/helpers/get-active-platform-fee-ranges.d.ts

@@ -0,0 +1,37 @@
+import { Country } from "../types/country";
+import { DayOfWeek } from "../types/day-of-week";
+import { PlatformFeeRange, PlatformFeeSchedule, PlatformFeesForCountry } from "../types/platform-fee-range";
+import { Side } from "../types/side";
+/**
+ * Returns the day of week and minute-of-day ([0, 1440)) for `now` in the
+ * given IANA timezone. Uses `Intl.DateTimeFormat` so DST transitions are
+ * applied automatically, mirroring the FX trading policy resolver.
+ */
+export declare const getLocalDayAndMinute: (now: Date, timezone: string) => {
+    dayOfWeek: DayOfWeek;
+    minuteOfDay: number;
+};
+/**
+ * A range with no schedule (or a malformed schedule with no days)
+ * applies at all times, which preserves the behavior of every range
+ * created before schedules existed.
+ */
+export declare const isPlatformFeeScheduleActive: (schedule: PlatformFeeSchedule | undefined, dayOfWeek: DayOfWeek, minuteOfDay: number) => boolean;
+/**
+ * Resolves the platform fee ranges that are in effect right now for a
+ * country/side: ranges whose schedule covers the current day and
+ * minute-of-day in the country's capital timezone (`getCountryTimezone`:
+ * Mexico City for MX, Lima for PE, Bogota for CO, New York for US), plus
+ * all unscheduled ranges. The result is sorted by `min` so callers can
+ * treat it as a volume ladder. Overlap validation at write time
+ * guarantees that at most one returned range covers any given amount.
+ *
+ * `now` is injectable so a quote and its downstream fee lookups can pin a
+ * single timestamp, and for testability.
+ */
+export declare const getActivePlatformFeeRanges: ({ platformFees, country, side, now, }: {
+    platformFees: PlatformFeesForCountry | undefined;
+    country: Country;
+    side: Side;
+    now?: Date | undefined;
+}) => PlatformFeeRange[] | undefined;

package/build/helpers/get-active-platform-fee-ranges.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getActivePlatformFeeRanges = exports.isPlatformFeeScheduleActive = exports.getLocalDayAndMinute = void 0;
+const day_of_week_1 = require("../types/day-of-week");
+const get_country_timezone_1 = require("./get-country-timezone");
+const WEEKDAY_TO_DAY_OF_WEEK = {
+    Mon: day_of_week_1.DayOfWeek.Monday,
+    Tue: day_of_week_1.DayOfWeek.Tuesday,
+    Wed: day_of_week_1.DayOfWeek.Wednesday,
+    Thu: day_of_week_1.DayOfWeek.Thursday,
+    Fri: day_of_week_1.DayOfWeek.Friday,
+    Sat: day_of_week_1.DayOfWeek.Saturday,
+    Sun: day_of_week_1.DayOfWeek.Sunday,
+};
+/**
+ * Returns the day of week and minute-of-day ([0, 1440)) for `now` in the
+ * given IANA timezone. Uses `Intl.DateTimeFormat` so DST transitions are
+ * applied automatically, mirroring the FX trading policy resolver.
+ */
+const getLocalDayAndMinute = (now, timezone) => {
+    var _a;
+    const parts = new Intl.DateTimeFormat("en-US", {
+        timeZone: timezone,
+        hour12: false,
+        weekday: "short",
+        hour: "2-digit",
+        minute: "2-digit",
+    }).formatToParts(now);
+    let weekday = "";
+    let hour = 0;
+    let minute = 0;
+    for (const part of parts) {
+        if (part.type === "weekday")
+            weekday = part.value;
+        if (part.type === "hour")
+            hour = parseInt(part.value, 10);
+        if (part.type === "minute")
+            minute = parseInt(part.value, 10);
+    }
+    // Intl formats midnight as "24" in some locales/Node versions; clamp
+    // defensively so we never return 1440 (which would miss a schedule's
+    // exclusive end bound).
+    if (hour === 24)
+        hour = 0;
+    return {
+        dayOfWeek: (_a = WEEKDAY_TO_DAY_OF_WEEK[weekday]) !== null && _a !== void 0 ? _a : day_of_week_1.DayOfWeek.Monday,
+        minuteOfDay: hour * 60 + minute,
+    };
+};
+exports.getLocalDayAndMinute = getLocalDayAndMinute;
+/**
+ * A range with no schedule (or a malformed schedule with no days)
+ * applies at all times, which preserves the behavior of every range
+ * created before schedules existed.
+ */
+const isPlatformFeeScheduleActive = (schedule, dayOfWeek, minuteOfDay) => {
+    if (!schedule || !schedule.daysOfWeek || schedule.daysOfWeek.length === 0) {
+        return true;
+    }
+    return (schedule.daysOfWeek.includes(dayOfWeek) &&
+        minuteOfDay >= schedule.startMinute &&
+        minuteOfDay < schedule.endMinute);
+};
+exports.isPlatformFeeScheduleActive = isPlatformFeeScheduleActive;
+/**
+ * Resolves the platform fee ranges that are in effect right now for a
+ * country/side: ranges whose schedule covers the current day and
+ * minute-of-day in the country's capital timezone (`getCountryTimezone`:
+ * Mexico City for MX, Lima for PE, Bogota for CO, New York for US), plus
+ * all unscheduled ranges. The result is sorted by `min` so callers can
+ * treat it as a volume ladder. Overlap validation at write time
+ * guarantees that at most one returned range covers any given amount.
+ *
+ * `now` is injectable so a quote and its downstream fee lookups can pin a
+ * single timestamp, and for testability.
+ */
+const getActivePlatformFeeRanges = ({ platformFees, country, side, now = new Date(), }) => {
+    const ranges = platformFees === null || platformFees === void 0 ? void 0 : platformFees[side];
+    if (!ranges || ranges.length === 0)
+        return ranges;
+    const { dayOfWeek, minuteOfDay } = (0, exports.getLocalDayAndMinute)(now, (0, get_country_timezone_1.getCountryTimezone)(country));
+    return ranges
+        .filter((range) => (0, exports.isPlatformFeeScheduleActive)(range.schedule, dayOfWeek, minuteOfDay))
+        .sort((a, b) => a.min - b.min);
+};
+exports.getActivePlatformFeeRanges = getActivePlatformFeeRanges;

package/build/index.d.ts

@@ -312,6 +312,7 @@ export * from "./types/compliance-tree-user";
 export * from "./types/compliance-recent-session";
 export * from "./types/compliance-step-type";
 export * from "./types/platform-fee-range";
+export * from "./types/day-of-week";
 export * from "./types/api-key";
 export * from "./types/authorization-type";
 export * from "./types/refresh-token";
@@ -555,6 +556,8 @@ export * from "./helpers/is-overnight-or-weekend-mexico-city";
 export * from "./helpers/get-user-payout-vault-id";
 export * from "./helpers/should-add-one-day-to-settlement-date";
 export * from "./helpers/get-country-timezone";
+export * from "./helpers/get-active-platform-fee-ranges";
+export * from "./helpers/find-platform-fee-range-conflict";
 export * from "./helpers/get-country-for-fiat";
 export * from "./helpers/get-days-between-agreed-two-way-settlement-date-and-payment-date";
 export * from "./helpers/get-days-until-two-way-settlement-date";

package/build/index.js

@@ -328,6 +328,7 @@ __exportStar(require("./types/compliance-tree-user"), exports);
 __exportStar(require("./types/compliance-recent-session"), exports);
 __exportStar(require("./types/compliance-step-type"), exports);
 __exportStar(require("./types/platform-fee-range"), exports);
+__exportStar(require("./types/day-of-week"), exports);
 __exportStar(require("./types/api-key"), exports);
 __exportStar(require("./types/authorization-type"), exports);
 __exportStar(require("./types/refresh-token"), exports);
@@ -571,6 +572,8 @@ __exportStar(require("./helpers/is-overnight-or-weekend-mexico-city"), exports);
 __exportStar(require("./helpers/get-user-payout-vault-id"), exports);
 __exportStar(require("./helpers/should-add-one-day-to-settlement-date"), exports);
 __exportStar(require("./helpers/get-country-timezone"), exports);
+__exportStar(require("./helpers/get-active-platform-fee-ranges"), exports);
+__exportStar(require("./helpers/find-platform-fee-range-conflict"), exports);
 __exportStar(require("./helpers/get-country-for-fiat"), exports);
 __exportStar(require("./helpers/get-days-between-agreed-two-way-settlement-date-and-payment-date"), exports);
 __exportStar(require("./helpers/get-days-until-two-way-settlement-date"), exports);

package/build/types/day-of-week.d.ts

@@ -0,0 +1,9 @@
+export declare enum DayOfWeek {
+    Monday = "monday",
+    Tuesday = "tuesday",
+    Wednesday = "wednesday",
+    Thursday = "thursday",
+    Friday = "friday",
+    Saturday = "saturday",
+    Sunday = "sunday"
+}

package/build/types/day-of-week.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DayOfWeek = void 0;
+var DayOfWeek;
+(function (DayOfWeek) {
+    DayOfWeek["Monday"] = "monday";
+    DayOfWeek["Tuesday"] = "tuesday";
+    DayOfWeek["Wednesday"] = "wednesday";
+    DayOfWeek["Thursday"] = "thursday";
+    DayOfWeek["Friday"] = "friday";
+    DayOfWeek["Saturday"] = "saturday";
+    DayOfWeek["Sunday"] = "sunday";
+})(DayOfWeek = exports.DayOfWeek || (exports.DayOfWeek = {}));

package/build/types/platform-fee-range.d.ts

@@ -1,8 +1,25 @@
+import { DayOfWeek } from "./day-of-week";
 import { DeferredPaymentType } from "./deferred-payment-type";
+/**
+ * Restricts when a fee range applies. The range is active when the
+ * current time in the country's capital timezone (Mexico City for MX
+ * ranges, Lima for PE, Bogota for CO, New York for US) falls on one of
+ * `daysOfWeek` and within `[startMinute, endMinute)` (minutes from
+ * midnight, end exclusive). Schedules that span midnight must be split
+ * into two ranges (one ending at 1440, one starting at 0 on the next
+ * day), mirroring the FX trading policy time-range convention. A range
+ * without a schedule applies at all times.
+ */
+export interface PlatformFeeSchedule {
+    daysOfWeek: DayOfWeek[];
+    startMinute: number;
+    endMinute: number;
+}
 export interface PlatformFeeRange {
     min: number;
     max: number;
     fee: number;
+    schedule?: PlatformFeeSchedule;
     deferredPaymentFee?: {
         [deferredPaymentType in DeferredPaymentType]: number;
     };
@@ -14,3 +31,7 @@ export interface PlatformFeeRange {
         [key: number]: number;
     };
 }
+export interface PlatformFeesForCountry {
+    buy?: PlatformFeeRange[];
+    sell?: PlatformFeeRange[];
+}

package/build/types/user-input.d.ts

@@ -3,7 +3,7 @@ import { CountryOfOrigin } from "./country-of-origin";
 import { Fiat } from "./fiat";
 import { MexicoInvoicingMethod } from "./mexico-invoicing-method";
 import { OnboardingStatus } from "./onboarding-status";
-import { PlatformFeeRange } from "./platform-fee-range";
+import { PlatformFeesForCountry } from "./platform-fee-range";
 import { UserAttribute } from "./user-attribute";
 import { UserType } from "./user-type";
 type IndividualUser = {
@@ -30,26 +30,11 @@ export type UserInput = {
     cosignerGroupId?: string;
     attributes?: UserAttribute[];
     platformFeeRanges?: {
-        MX?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        PE?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        CO?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        BR?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        US?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
+        MX?: PlatformFeesForCountry;
+        PE?: PlatformFeesForCountry;
+        CO?: PlatformFeesForCountry;
+        BR?: PlatformFeesForCountry;
+        US?: PlatformFeesForCountry;
     };
     onboarding?: {
         country?: Country;

package/build/types/user-update.d.ts

@@ -1,6 +1,6 @@
 import { CountryOfOrigin } from "./country-of-origin";
 import { OnboardingStatus } from "./onboarding-status";
-import { PlatformFeeRange } from "./platform-fee-range";
+import { PlatformFeesForCountry } from "./platform-fee-range";
 import { UserAttribute } from "./user-attribute";
 import { UserType } from "./user-type";
 import { Country } from "./country";
@@ -32,26 +32,11 @@ export type UserUpdate = {
     cosignerGroupId?: string;
     attributes?: UserAttribute[];
     platformFeeRanges?: {
-        MX?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        PE?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        CO?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        BR?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        US?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
+        MX?: PlatformFeesForCountry;
+        PE?: PlatformFeesForCountry;
+        CO?: PlatformFeesForCountry;
+        BR?: PlatformFeesForCountry;
+        US?: PlatformFeesForCountry;
     };
     onboarding?: {
         country?: Country;

package/build/types/user.d.ts

@@ -1,6 +1,6 @@
 import { CountryOfOrigin } from "./country-of-origin";
 import { OnboardingStatus } from "./onboarding-status";
-import { PlatformFeeRange } from "./platform-fee-range";
+import { PlatformFeesForCountry } from "./platform-fee-range";
 import { UserAttribute } from "./user-attribute";
 import { UserType } from "./user-type";
 import { Country } from "./country";
@@ -35,26 +35,11 @@ export type User = {
     cosignerGroupId?: string;
     attributes?: UserAttribute[];
     platformFeeRanges?: {
-        MX?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        PE?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        CO?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        BR?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
-        US?: {
-            buy?: PlatformFeeRange[];
-            sell?: PlatformFeeRange[];
-        };
+        MX?: PlatformFeesForCountry;
+        PE?: PlatformFeesForCountry;
+        CO?: PlatformFeesForCountry;
+        BR?: PlatformFeesForCountry;
+        US?: PlatformFeesForCountry;
     };
     onboarding: {
         country: Country;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riocrypto/common",
-  "version": "1.0.2670",
+  "version": "1.0.2673",
   "description": "",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",