@riocrypto/common 1.0.2196 → 1.0.2198

package/build/helpers/get-lower-order-statuses.d.ts

@@ -0,0 +1,4 @@
+import { DeferredPaymentType } from "../types/deferred-payment-type";
+import { OrderStatus } from "../types/order-status";
+import { Side } from "../types/side";
+export declare const getLowerOrderStatuses: (side: Side, deferredPaymentType: DeferredPaymentType, currentStatus: OrderStatus, lessThanOrEqualTo?: boolean) => OrderStatus[];

package/build/helpers/get-lower-order-statuses.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getLowerOrderStatuses = void 0;
+const get_order_status_rankings_1 = require("./get-order-status-rankings");
+const getLowerOrderStatuses = (side, deferredPaymentType, currentStatus, lessThanOrEqualTo = false) => {
+    const orderStatusRanking = (0, get_order_status_rankings_1.getOrderStatusRanking)(side, deferredPaymentType);
+    if (lessThanOrEqualTo) {
+        return Object.entries(orderStatusRanking)
+            .filter(([_, ranking]) => ranking <=
+            orderStatusRanking[currentStatus])
+            .map(([statusKey]) => statusKey);
+    }
+    else {
+        return Object.entries(orderStatusRanking)
+            .filter(([_, ranking]) => ranking <
+            orderStatusRanking[currentStatus])
+            .map(([statusKey]) => statusKey);
+    }
+};
+exports.getLowerOrderStatuses = getLowerOrderStatuses;

package/build/helpers/get-order-status-rankings.d.ts

@@ -0,0 +1,107 @@
+import { DeferredPaymentType } from "../types/deferred-payment-type";
+import { Side } from "../types/side";
+export declare const BuyOrderStatusRanking: {
+    awaitingTimeInForceToStart: number;
+    awaitingLimitPriceCondition: number;
+    created: number;
+    addressCheckPassed: number;
+    awaitingPayment: number;
+    processing: number;
+    paid: number;
+    sourcingLiquidity: number;
+    liquiditySourced: number;
+    filled: number;
+    complete: number;
+};
+export declare const SellOrderStatusRanking: {
+    awaitingTimeInForceToStart: number;
+    awaitingLimitPriceCondition: number;
+    created: number;
+    depositAddressCreated: number;
+    awaitingBankPayoutDetails: number;
+    bankPayoutDetailsAdded: number;
+    awaitingPayment: number;
+    depositConfirmed: number;
+    sourcingLiquidity: number;
+    liquiditySourced: number;
+    awaitingPayout: number;
+    complete: number;
+};
+export declare const AsyncBuyOrderStatusRanking: {
+    awaitingTimeInForceToStart: number;
+    awaitingLimitPriceCondition: number;
+    created: number;
+    addressCheckPassed: number;
+    awaitingAsyncPayout: number;
+    sourcingLiquidity: number;
+    liquiditySourced: number;
+    filled: number;
+    awaitingAsyncPayment: number;
+    processing: number;
+    complete: number;
+};
+export declare const AsyncSellOrderStatusRanking: {
+    awaitingTimeInForceToStart: number;
+    awaitingLimitPriceCondition: number;
+    created: number;
+    depositAddressCreated: number;
+    awaitingBankPayoutDetails: number;
+    bankPayoutDetailsAdded: number;
+    sourcingLiquidity: number;
+    liquiditySourced: number;
+    awaitingAsyncPayout: number;
+    awaitingAsyncPayment: number;
+    processing: number;
+    complete: number;
+};
+export declare const getOrderStatusRanking: (side: Side, deferredPaymentType: DeferredPaymentType) => {
+    awaitingTimeInForceToStart: number;
+    awaitingLimitPriceCondition: number;
+    created: number;
+    addressCheckPassed: number;
+    awaitingPayment: number;
+    processing: number;
+    paid: number;
+    sourcingLiquidity: number;
+    liquiditySourced: number;
+    filled: number;
+    complete: number;
+} | {
+    awaitingTimeInForceToStart: number;
+    awaitingLimitPriceCondition: number;
+    created: number;
+    depositAddressCreated: number;
+    awaitingBankPayoutDetails: number;
+    bankPayoutDetailsAdded: number;
+    awaitingPayment: number;
+    depositConfirmed: number;
+    sourcingLiquidity: number;
+    liquiditySourced: number;
+    awaitingPayout: number;
+    complete: number;
+} | {
+    awaitingTimeInForceToStart: number;
+    awaitingLimitPriceCondition: number;
+    created: number;
+    addressCheckPassed: number;
+    awaitingAsyncPayout: number;
+    sourcingLiquidity: number;
+    liquiditySourced: number;
+    filled: number;
+    awaitingAsyncPayment: number;
+    processing: number;
+    complete: number;
+} | {
+    awaitingTimeInForceToStart: number;
+    awaitingLimitPriceCondition: number;
+    created: number;
+    depositAddressCreated: number;
+    awaitingBankPayoutDetails: number;
+    bankPayoutDetailsAdded: number;
+    sourcingLiquidity: number;
+    liquiditySourced: number;
+    awaitingAsyncPayout: number;
+    awaitingAsyncPayment: number;
+    processing: number;
+    complete: number;
+};

package/build/helpers/get-order-status-rankings.js

@@ -0,0 +1,82 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getOrderStatusRanking = exports.AsyncSellOrderStatusRanking = exports.AsyncBuyOrderStatusRanking = exports.SellOrderStatusRanking = exports.BuyOrderStatusRanking = void 0;
+const deferred_payment_type_1 = require("../types/deferred-payment-type");
+const order_status_1 = require("../types/order-status");
+const side_1 = require("../types/side");
+// Does not include all possible order statuses, just for a happy path flow
+exports.BuyOrderStatusRanking = {
+    [order_status_1.OrderStatus.AwaitingTimeInForceToStart]: 0,
+    [order_status_1.OrderStatus.AwaitingLimitPriceCondition]: 1,
+    [order_status_1.OrderStatus.Created]: 2,
+    [order_status_1.OrderStatus.AddressCheckPassed]: 3,
+    [order_status_1.OrderStatus.AwaitingPayment]: 4,
+    [order_status_1.OrderStatus.Processing]: 5,
+    [order_status_1.OrderStatus.Paid]: 6,
+    [order_status_1.OrderStatus.SourcingLiquidity]: 7,
+    [order_status_1.OrderStatus.LiquiditySourced]: 8,
+    [order_status_1.OrderStatus.Filled]: 9,
+    [order_status_1.OrderStatus.Complete]: 10,
+};
+exports.SellOrderStatusRanking = {
+    [order_status_1.OrderStatus.AwaitingTimeInForceToStart]: 0,
+    [order_status_1.OrderStatus.AwaitingLimitPriceCondition]: 1,
+    [order_status_1.OrderStatus.Created]: 2,
+    [order_status_1.OrderStatus.DepositAddressCreated]: 3,
+    [order_status_1.OrderStatus.AwaitingBankPayoutDetails]: 4,
+    [order_status_1.OrderStatus.BankPayoutDetailsAdded]: 5,
+    [order_status_1.OrderStatus.AwaitingPayment]: 6,
+    [order_status_1.OrderStatus.DepositConfirmed]: 7,
+    [order_status_1.OrderStatus.SourcingLiquidity]: 8,
+    [order_status_1.OrderStatus.LiquiditySourced]: 9,
+    [order_status_1.OrderStatus.AwaitingPayout]: 10,
+    [order_status_1.OrderStatus.Complete]: 11,
+};
+exports.AsyncBuyOrderStatusRanking = {
+    [order_status_1.OrderStatus.AwaitingTimeInForceToStart]: 0,
+    [order_status_1.OrderStatus.AwaitingLimitPriceCondition]: 1,
+    [order_status_1.OrderStatus.Created]: 2,
+    [order_status_1.OrderStatus.AddressCheckPassed]: 3,
+    [order_status_1.OrderStatus.AwaitingAsyncPayout]: 4,
+    [order_status_1.OrderStatus.SourcingLiquidity]: 5,
+    [order_status_1.OrderStatus.LiquiditySourced]: 6,
+    [order_status_1.OrderStatus.Filled]: 7,
+    [order_status_1.OrderStatus.AwaitingAsyncPayment]: 8,
+    [order_status_1.OrderStatus.Processing]: 9,
+    [order_status_1.OrderStatus.Complete]: 10,
+};
+exports.AsyncSellOrderStatusRanking = {
+    [order_status_1.OrderStatus.AwaitingTimeInForceToStart]: 0,
+    [order_status_1.OrderStatus.AwaitingLimitPriceCondition]: 1,
+    [order_status_1.OrderStatus.Created]: 2,
+    [order_status_1.OrderStatus.DepositAddressCreated]: 3,
+    [order_status_1.OrderStatus.AwaitingBankPayoutDetails]: 4,
+    [order_status_1.OrderStatus.BankPayoutDetailsAdded]: 5,
+    [order_status_1.OrderStatus.SourcingLiquidity]: 6,
+    [order_status_1.OrderStatus.LiquiditySourced]: 7,
+    [order_status_1.OrderStatus.AwaitingAsyncPayout]: 8,
+    [order_status_1.OrderStatus.AwaitingAsyncPayment]: 9,
+    [order_status_1.OrderStatus.Processing]: 10,
+    [order_status_1.OrderStatus.Complete]: 11,
+};
+const getOrderStatusRanking = (side, deferredPaymentType) => {
+    if (side === side_1.Side.Buy && deferredPaymentType === deferred_payment_type_1.DeferredPaymentType.None) {
+        return exports.BuyOrderStatusRanking;
+    }
+    else if (side === side_1.Side.Sell &&
+        deferredPaymentType === deferred_payment_type_1.DeferredPaymentType.None) {
+        return exports.SellOrderStatusRanking;
+    }
+    else if (side === side_1.Side.Buy &&
+        deferredPaymentType !== deferred_payment_type_1.DeferredPaymentType.None) {
+        return exports.AsyncBuyOrderStatusRanking;
+    }
+    else if (side === side_1.Side.Sell &&
+        deferredPaymentType !== deferred_payment_type_1.DeferredPaymentType.None) {
+        return exports.AsyncSellOrderStatusRanking;
+    }
+    else {
+        throw new Error("Invalid side or deferred payment type");
+    }
+};
+exports.getOrderStatusRanking = getOrderStatusRanking;

package/build/helpers/humanize-order-status.js

@@ -90,6 +90,10 @@ const humanizeOrderStatus = (status) => {
             return "Refund initiated";
         case order_status_1.OrderStatus.AwaitingOriginOrderCompletion:
             return "Waiting for origin order to complete";
+        case order_status_1.OrderStatus.AwaitingTimeInForceToStart:
+            return "Waiting for time in force to start";
+        case order_status_1.OrderStatus.AwaitingLimitPriceCondition:
+            return "Waiting for limit price condition";
         default:
             if (status.toLowerCase().includes("failed")) {
                 return "Failed";

package/build/index.d.ts

@@ -404,5 +404,7 @@ export * from "./helpers/get-country-timezone";
 export * from "./helpers/get-days-between-agreed-two-way-settlement-date-and-payment-date";
 export * from "./helpers/get-days-until-two-way-settlement-date";
 export * from "./helpers/get-two-way-settlement-date";
+export * from "./helpers/get-order-status-rankings";
+export * from "./helpers/get-lower-order-statuses";
 export * from "./constants/mexico-fiscal-regimens";
 export * from "./constants/mexican-banks";

package/build/index.js

@@ -420,5 +420,7 @@ __exportStar(require("./helpers/get-country-timezone"), 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);
 __exportStar(require("./helpers/get-two-way-settlement-date"), exports);
+__exportStar(require("./helpers/get-order-status-rankings"), exports);
+__exportStar(require("./helpers/get-lower-order-statuses"), exports);
 __exportStar(require("./constants/mexico-fiscal-regimens"), exports);
 __exportStar(require("./constants/mexican-banks"), exports);

package/build/types/order-status.d.ts

@@ -3,6 +3,7 @@ export declare enum OrderStatus {
     Cancelled = "cancelled",
     Processing = "processing",
     AwaitingLimitPriceCondition = "awaitingLimitPriceCondition",
+    AwaitingTimeInForceToStart = "awaitingTimeInForceToStart",
     LimitPriceConditionMet = "limitPriceConditionMet",
     SourcingLiquidity = "sourcingLiquidity",
     CryptoAddressAdded = "cryptoAddressAdded",

package/build/types/order-status.js

@@ -12,6 +12,7 @@ var OrderStatus;
     // processor
     OrderStatus["Processing"] = "processing";
     OrderStatus["AwaitingLimitPriceCondition"] = "awaitingLimitPriceCondition";
+    OrderStatus["AwaitingTimeInForceToStart"] = "awaitingTimeInForceToStart";
     OrderStatus["LimitPriceConditionMet"] = "limitPriceConditionMet";
     OrderStatus["SourcingLiquidity"] = "sourcingLiquidity";
     OrderStatus["CryptoAddressAdded"] = "cryptoAddressAdded";

package/package.json

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