@riocrypto/common 1.0.2707 → 1.0.2709

package/build/helpers/get-documented-enums.d.ts

@@ -0,0 +1,11 @@
+import { Country } from "../types/country";
+import { Crypto } from "../types/crypto";
+import { Fiat } from "../types/fiat";
+import { OnboardingStatus } from "../types/onboarding-status";
+import { OrderStatus } from "../types/order-status";
+export declare const documentedOrderStatusDescription = "These are the statuses an order moves through on a normal flow, and which ones it sees depends on whether it is a buy or a sell and on whether payment is deferred. Other statuses can appear depending on the circumstances of the order.";
+export declare const getDocumentedCryptos: () => Crypto[];
+export declare const getDocumentedFiats: () => Fiat[];
+export declare const getDocumentedCountries: () => Country[];
+export declare const getDocumentedOnboardingStatuses: () => OnboardingStatus[];
+export declare const getDocumentedOrderStatuses: () => OrderStatus[];

package/build/helpers/get-documented-enums.js

@@ -0,0 +1,61 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getDocumentedOrderStatuses = exports.getDocumentedOnboardingStatuses = exports.getDocumentedCountries = exports.getDocumentedFiats = exports.getDocumentedCryptos = exports.documentedOrderStatusDescription = void 0;
+const country_1 = require("../types/country");
+const crypto_1 = require("../types/crypto");
+const fiat_1 = require("../types/fiat");
+const onboarding_status_1 = require("../types/onboarding-status");
+const order_status_1 = require("../types/order-status");
+const stablecoin_type_1 = require("../types/stablecoin-type");
+const get_order_status_rankings_1 = require("./get-order-status-rankings");
+const is_us_operations_enabled_1 = require("./is-us-operations-enabled");
+// The values the public API documentation advertises. Swagger used to read the
+// raw enums, which meant every internal failure state, retired asset and market
+// we do not sell in ended up in the customer facing specs, so the swagger
+// sources read from here instead.
+// The bridged Polygon contract, which we no longer hand out.
+const RETIRED_CRYPTOS = [crypto_1.Crypto.USDCPolygonBridged];
+const DOCUMENTED_COUNTRIES = [
+    country_1.Country.Mexico,
+    country_1.Country.Peru,
+    country_1.Country.Colombia,
+];
+const DOCUMENTED_ONBOARDING_STATUSES = [
+    onboarding_status_1.OnboardingStatus.None,
+    onboarding_status_1.OnboardingStatus.Onboarding,
+    onboarding_status_1.OnboardingStatus.Review,
+    onboarding_status_1.OnboardingStatus.Approved,
+    onboarding_status_1.OnboardingStatus.Declined,
+];
+exports.documentedOrderStatusDescription = "These are the statuses an order moves through on a normal flow, and which ones it sees depends on whether it is a buy or a sell and on whether payment is deferred. Other statuses can appear depending on the circumstances of the order.";
+const getDocumentedCryptos = () => [...stablecoin_type_1.USD_BACKED_CRYPTOS, ...stablecoin_type_1.EUR_BACKED_CRYPTOS].filter((crypto) => !RETIRED_CRYPTOS.includes(crypto));
+exports.getDocumentedCryptos = getDocumentedCryptos;
+const getDocumentedFiats = () => Object.values(fiat_1.Fiat).filter((fiat) => fiat !== fiat_1.Fiat.Other);
+exports.getDocumentedFiats = getDocumentedFiats;
+const getDocumentedCountries = () => is_us_operations_enabled_1.US_OPERATIONS_ENABLED
+    ? [...DOCUMENTED_COUNTRIES, country_1.Country.UnitedStates]
+    : [...DOCUMENTED_COUNTRIES];
+exports.getDocumentedCountries = getDocumentedCountries;
+const getDocumentedOnboardingStatuses = () => [
+    ...DOCUMENTED_ONBOARDING_STATUSES,
+];
+exports.getDocumentedOnboardingStatuses = getDocumentedOnboardingStatuses;
+// Neither shows up in the rankings because an order does not pass through them
+// on its way anywhere, but a customer can cancel an order and can let a quote
+// run out, so both are worth documenting.
+const DOCUMENTED_TERMINAL_ORDER_STATUSES = [
+    order_status_1.OrderStatus.Cancelled,
+    order_status_1.OrderStatus.Expired,
+];
+const getDocumentedOrderStatuses = () => {
+    const happyPath = [
+        ...Object.keys(get_order_status_rankings_1.BuyOrderStatusRanking),
+        ...Object.keys(get_order_status_rankings_1.SellOrderStatusRanking),
+        ...Object.keys(get_order_status_rankings_1.AsyncBuyOrderStatusRanking),
+        ...Object.keys(get_order_status_rankings_1.AsyncSellOrderStatusRanking),
+    ];
+    return [
+        ...new Set([...happyPath, ...DOCUMENTED_TERMINAL_ORDER_STATUSES]),
+    ];
+};
+exports.getDocumentedOrderStatuses = getDocumentedOrderStatuses;

package/build/index.d.ts

@@ -587,6 +587,7 @@ export * from "./helpers/get-days-until-two-way-settlement-date";
 export * from "./helpers/get-two-way-settlement-date-offset-from-date";
 export * from "./helpers/get-two-way-settlement-date";
 export * from "./helpers/get-order-status-rankings";
+export * from "./helpers/get-documented-enums";
 export * from "./helpers/get-lower-order-statuses";
 export * from "./helpers/is-us-operations-enabled";
 export * from "./constants/mexico-fiscal-regimens";

package/build/index.js

@@ -603,6 +603,7 @@ __exportStar(require("./helpers/get-days-until-two-way-settlement-date"), export
 __exportStar(require("./helpers/get-two-way-settlement-date-offset-from-date"), exports);
 __exportStar(require("./helpers/get-two-way-settlement-date"), exports);
 __exportStar(require("./helpers/get-order-status-rankings"), exports);
+__exportStar(require("./helpers/get-documented-enums"), exports);
 __exportStar(require("./helpers/get-lower-order-statuses"), exports);
 __exportStar(require("./helpers/is-us-operations-enabled"), exports);
 __exportStar(require("./constants/mexico-fiscal-regimens"), exports);

package/package.json

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