@riocrypto/common 1.0.2703 → 1.0.2705

package/build/index.d.ts

@@ -293,6 +293,7 @@ export * from "./types/payout-method";
 export * from "./types/processor";
 export * from "./types/processor-routing";
 export * from "./types/processor-readiness";
+export * from "./types/routing-decision";
 export * from "./types/payment-address-verification";
 export * from "./types/side";
 export * from "./types/auth";

package/build/index.js

@@ -309,6 +309,7 @@ __exportStar(require("./types/payout-method"), exports);
 __exportStar(require("./types/processor"), exports);
 __exportStar(require("./types/processor-routing"), exports);
 __exportStar(require("./types/processor-readiness"), exports);
+__exportStar(require("./types/routing-decision"), exports);
 __exportStar(require("./types/payment-address-verification"), exports);
 __exportStar(require("./types/side"), exports);
 __exportStar(require("./types/auth"), exports);

package/build/types/processor-readiness.d.ts

@@ -36,3 +36,8 @@ export interface ProcessorReadiness {
     verifiedByAdminId?: string;
     verificationNote?: string;
 }
+export interface ProcessorEnablementState {
+    enabled: Processor[];
+    disabled: Processor[];
+    unset: Processor[];
+}

package/build/types/rio-settings.d.ts

@@ -69,6 +69,7 @@ export interface RioSettings {
         };
     };
     processorRouting?: ProcessorRoutingConfig;
+    requireExplicitPayinEnablement?: boolean;
     TVFXDataProvider: {
         [key in Fiat]?: TVFXDataProvider;
     };

package/build/types/routing-decision.d.ts

@@ -0,0 +1,25 @@
+import { Processor } from "./processor";
+export declare enum RoutingDecisionReason {
+    CustomRioBankAccount = "customRioBankAccount",
+    CustomRioBankAccountWithoutRail = "customRioBankAccountWithoutRail",
+    Split = "split",
+    OnlyCandidate = "onlyCandidate",
+    EnabledRailWithoutShare = "enabledRailWithoutShare",
+    NoEligibleCandidate = "noEligibleCandidate",
+    NoEnabledCandidate = "noEnabledCandidate",
+    NoAcceptedCandidate = "noAcceptedCandidate",
+    Structural = "structural"
+}
+export interface RoutingDecision {
+    processor?: Processor;
+    reason: RoutingDecisionReason;
+    corridor: Processor[];
+    excluded?: Processor[];
+    disabled?: Processor[];
+    unset?: Processor[];
+    percentages?: {
+        [processor in Processor]?: number;
+    };
+    seed?: number;
+    decidedAt: Date;
+}

package/build/types/routing-decision.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RoutingDecisionReason = void 0;
+// Why an order ended up on the rail it did. A decision without a processor is a
+// deliberate refusal rather than a bug, so the reasons cover both outcomes.
+var RoutingDecisionReason;
+(function (RoutingDecisionReason) {
+    // The customer pays into a Rio bank account of their own, which fixes the rail
+    // because it is where the money physically lands.
+    RoutingDecisionReason["CustomRioBankAccount"] = "customRioBankAccount";
+    // Same, for an account recorded before we tracked which rail it belongs to.
+    // Hands back to the structural default rather than guessing.
+    RoutingDecisionReason["CustomRioBankAccountWithoutRail"] = "customRioBankAccountWithoutRail";
+    // Drawn from the configured split.
+    RoutingDecisionReason["Split"] = "split";
+    // One rail carried a share, so there was nothing to draw.
+    RoutingDecisionReason["OnlyCandidate"] = "onlyCandidate";
+    // Rails were available but none carried a share, so the corridor default was
+    // used. Reached by a corridor with no rule saved, or one whose shares are all
+    // zero, and by a customer whose only rails sit at zero.
+    RoutingDecisionReason["EnabledRailWithoutShare"] = "enabledRailWithoutShare";
+    // No rail in the corridor is reachable from this environment at all.
+    RoutingDecisionReason["NoEligibleCandidate"] = "noEligibleCandidate";
+    // Rails exist but the customer has switched all of them off.
+    RoutingDecisionReason["NoEnabledCandidate"] = "noEnabledCandidate";
+    // Buys only, while payin accounts are opt-in. The customer has turned none of
+    // the corridor's rails on, so there is nowhere they have agreed to pay.
+    RoutingDecisionReason["NoAcceptedCandidate"] = "noAcceptedCandidate";
+    // Structural routing, where the corridor has a single rail and nothing to
+    // decide.
+    RoutingDecisionReason["Structural"] = "structural";
+})(RoutingDecisionReason = exports.RoutingDecisionReason || (exports.RoutingDecisionReason = {}));

package/package.json

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