squarefi-bff-api-module 1.36.25 → 1.36.27

package/dist/api/orders.d.ts

@@ -1,9 +1,5 @@
 import { API } from './types/types';
 export declare const orders: {
-    calc: ({ signal, ...params }: API.Orders.Calc.Request) => Promise<API.Orders.Calc.Response>;
-    orderTypes: {
-        list: () => Promise<API.Orders.OrderTypes.List.Response>;
-    };
     create: {
         byOrderType: {
             TRANSFER_INTERNAL: (data: API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Request) => Promise<API.Orders.Create.ByOrderType.INTERNAL_TRANSFER.Response>;

package/dist/api/orders.js

@@ -1,13 +1,6 @@
 import { apiClientV1, apiClientV1Frontend } from '../utils/apiClientFactory';
 import { OrderType } from '../constants';
 export const orders = {
-    calc: ({ signal, ...params }) => apiClientV1.getRequest('/orders/calc', {
-        params,
-        signal,
-    }),
-    orderTypes: {
-        list: () => apiClientV1.getRequest('/orders/order_types'),
-    },
     create: {
         byOrderType: {
             [OrderType.TRANSFER_INTERNAL]: (data) => apiClientV1.postRequest('/orders/INTERNAL_TRANSFER', {

package/dist/api/types/autogen/apiV1Frontend.types.d.ts

@@ -4950,7 +4950,8 @@ export interface paths {
                         amount: number;
                         /** @description Idempotency key (UUID) */
                         request_id: string;
-                        documents?: Record<string, never>[];
+                        /** @description Optional supporting documents persisted with the order. */
+                        documents?: components["schemas"]["OrderDocumentInput"][];
                     };
                 };
             };
@@ -5620,6 +5621,8 @@ export interface paths {
                         /** @description Idempotency key */
                         reference_id?: string;
                         note?: string;
+                        /** @description Optional supporting documents persisted with the order. */
+                        documents?: components["schemas"]["OrderDocumentInput"][];
                     };
                 };
             };
@@ -6006,7 +6009,10 @@ export interface paths {
                     from_currency_id: string;
                     to_currency_id: string;
                     /** @description If `true`, calculates inputs needed to receive the given amount. */
-                    is_reverse?: "true" | "false";
+                    is_reverse: boolean;
+                    /** @description If `true`, the network fee is subtracted from `result_amount`. If `false`, the fee is added on top of `from_amount` and the recipient gets the full converted amount. Ignored for reverse calculations. Required so the client always states the fee-allocation mode explicitly — a change of the server-side fallback can never silently alter the calculation.
+                     *      */
+                    is_subtract: boolean;
                     /** @description Destination address (for crypto withdrawals; affects network fee estimation). */
                     to_address?: string;
                 };
@@ -6021,7 +6027,13 @@ export interface paths {
                     headers: {
                         [name: string]: unknown;
                     };
-                    content?: never;
+                    content: {
+                        "application/json": {
+                            /** @example true */
+                            success: boolean;
+                            data: components["schemas"]["OrderCalculation"];
+                        };
+                    };
                 };
                 /** @description Invalid request (e.g. unknown `order_type`, missing required parameter, exchange rate not found) */
                 400: {
@@ -6032,6 +6044,15 @@ export interface paths {
                         "application/json": components["schemas"]["ErrorResponse"];
                     };
                 };
+                /** @description Calculation failed (e.g. network fee estimation error) */
+                500: {
+                    headers: {
+                        [name: string]: unknown;
+                    };
+                    content: {
+                        "application/json": components["schemas"]["ErrorResponse"];
+                    };
+                };
             };
         };
         put?: never;
@@ -10053,6 +10074,58 @@ export interface components {
          * @enum {string}
          */
         OrderTypeId: "EXCHANGE_OMNI" | "EXCHANGE_OMNI_ONRAMP" | "EXCHANGE_OMNI_OFFRAMP" | "EXCHANGE_OMNI_CRYPTO" | "EXCHANGE_CRYPTO_INTERNAL" | "L2F_ACH_ONRAMP" | "L2F_ACH_OFFRAMP" | "L2F_SEPA_ONRAMP" | "L2F_SEPA_OFFRAMP" | "L2F_SWIFT_ONRAMP" | "L2F_SWIFT_OFFRAMP" | "L2F_WIRE_ONRAMP" | "L2F_WIRE_OFFRAMP" | "L2F_CHAPS_ONRAMP" | "L2F_CHAPS_OFFRAMP" | "L2F_FPS_ONRAMP" | "L2F_FPS_OFFRAMP" | "BRL_WIRE_ONRAMP" | "BRL_WIRE_OFFRAMP" | "BRL_ACH_ONRAMP" | "BRL_ACH_OFFRAMP" | "BRL_RTP_OFFRAMP" | "DLS_WIRE_ONRAMP" | "DLS_WIRE_OFFRAMP" | "DLS_ACH_ONRAMP" | "DLS_ACH_OFFRAMP" | "DLS_SEPA_ONRAMP" | "DLS_SEPA_OFFRAMP" | "DLS_SWIFT_ONRAMP" | "DLS_SWIFT_OFFRAMP" | "OMNIBUS_CRYPTO_TRANSFER" | "OMNIBUS_CRYPTO_WITHDRAWAL" | "OMNIBUS_INTERNAL_TRANSFER" | "SEGREGATED_CRYPTO_TRANSFER" | "TRANSFER_INTERNAL" | "TRANSFER_CARD_PREPAID" | "TRANSFER_CARD_SUBACCOUNT" | "TRANSFER_CARD_WHOLESALE" | "WITHDRAW_CARD_PREPAID" | "WITHDRAW_CARD_SUBACCOUNT" | "REFUND_CARD_PREPAID" | "REFUND_CARD_SUBACCOUNT" | "RN_CARDS_OFFRAMP" | "CARD_ISSUING_FEE";
+        OrderCalculation: {
+            /**
+             * Format: uuid
+             * @description Source currency UUID.
+             */
+            from_currency: string;
+            /**
+             * Format: uuid
+             * @description Destination currency UUID.
+             */
+            to_currency: string;
+            /**
+             * @description Amount to be spent in the source currency.
+             * @example 100
+             */
+            from_amount: number;
+            /**
+             * @description Amount to be received in the destination currency.
+             * @example 98.5
+             */
+            result_amount: number;
+            /**
+             * @description Exchange rate applied (source → destination), 6 decimals.
+             * @example 0.985
+             */
+            rate: number;
+            /**
+             * @description Total fees (comission + network_fee), in the source currency.
+             * @example 1.5
+             */
+            fees: number;
+            /**
+             * @description Service commission (wire name is intentionally `comission`).
+             * @example 1.5
+             */
+            comission: number;
+            /**
+             * @description Estimated blockchain network fee (crypto withdrawals only, otherwise 0).
+             * @example 0
+             */
+            network_fee: number;
+            /**
+             * @description Transaction fee. Always 0 for now.
+             * @example 0
+             */
+            transaction_fee: number;
+            /**
+             * @description Source currency symbol.
+             * @example USDT
+             */
+            from_symbol: string;
+        };
         PaginationResponse: {
             offset: number;
             limit: number;
@@ -10694,6 +10767,15 @@ export interface components {
                 [key: string]: unknown;
             }[];
         };
+        /** @description Supporting document attached to an order at creation time (persisted to order_documents). */
+        OrderDocumentInput: {
+            /**
+             * Format: uri
+             * @description Document URL (must be a valid URL)
+             */
+            url: string;
+            description?: string;
+        };
         FrontendCryptoTransferRequest: {
             /**
              * Format: uuid
@@ -10713,6 +10795,8 @@ export interface components {
             request_id: string;
             reference?: string;
             note?: string;
+            /** @description Optional supporting documents persisted with the order. */
+            documents?: components["schemas"]["OrderDocumentInput"][];
         };
         FrontendL2FOrderRequest: {
             /**
@@ -10733,6 +10817,8 @@ export interface components {
             request_id: string;
             reference?: string;
             note?: string;
+            /** @description Optional supporting documents persisted with the order. */
+            documents?: components["schemas"]["OrderDocumentInput"][];
         };
         FrontendExchangeOrderRequest: {
             /** Format: uuid */

package/dist/api/types/types.d.ts

@@ -1758,6 +1758,8 @@ export declare namespace API {
             }
         }
         namespace Frontend {
+            type OrderDocumentInput = componentsV1Frontend['schemas']['OrderDocumentInput'];
+            type OrderCalculation = componentsV1Frontend['schemas']['OrderCalculation'];
             type OrderEnvelope = {
                 success?: boolean;
                 data?: componentsV1Frontend['schemas']['Order'];
@@ -1834,7 +1836,7 @@ export declare namespace API {
                 type Request = pathsV1Frontend['/frontend/orders/calc']['get']['parameters']['query'] & {
                     signal?: AbortSignal;
                 };
-                type Response = API.Orders.Calc.Response;
+                type Response = pathsV1Frontend['/frontend/orders/calc']['get']['responses'][200]['content']['application/json'];
             }
             namespace GetById {
                 type Request = pathsV1Frontend['/frontend/orders/id/{order_id}']['get']['parameters']['path'];

package/dist/hooks/useCalc.d.ts

@@ -1,13 +1,32 @@
-import { API } from '../api/types/types';
-type CalcData = API.Orders.V2.Calc.Response & {
+type CalcResult = {
+    from_currency: string;
+    to_currency: string;
+    from_amount: number;
+    result_amount: number;
+    rate: number;
+    fees: number;
+    comission: number;
+    network_fee: number;
+    transaction_fee: number;
+    from_symbol: string;
+};
+type CalcData = CalcResult & {
     is_subtract: boolean;
     is_reverse: boolean;
 };
-export type OrderCalcHandlerProps = Omit<API.Orders.V2.Calc.Request, 'order_type'>;
+export type OrderCalcHandlerProps = {
+    from_currency_id: string;
+    to_currency_id: string;
+    amount: number;
+    is_reverse: boolean;
+    is_subtract: boolean;
+    to_address?: string;
+    signal?: AbortSignal;
+};
 export type UseOrderCalcProps = {
     from_currency_id: string | null | undefined;
     to_currency_id: string | null | undefined;
-    calcHandler: (props: OrderCalcHandlerProps) => Promise<API.Orders.V2.Calc.Response>;
+    calcHandler: (props: OrderCalcHandlerProps) => Promise<CalcResult>;
     disableCalculation?: boolean;
     to_address?: string;
 };

package/dist/hooks/useCalc.js

@@ -1,7 +1,6 @@
 import debounce from 'lodash.debounce';
 import { useEffect, useRef, useState } from 'react';
-export const useOrderCalc = (props) => {
-    const { from_currency_id, to_currency_id, calcHandler, disableCalculation, to_address } = props;
+export const useOrderCalc = ({ from_currency_id, to_currency_id, calcHandler, disableCalculation, to_address, }) => {
     const [sellingAmount, setSellingAmount] = useState(0);
     const [buyingAmount, setBuyingAmount] = useState(0);
     const [calcData, setCalcData] = useState(null);
@@ -49,7 +48,16 @@ export const useOrderCalc = (props) => {
             is_reverse ? setIsSellingValuePending(true) : setIsBuyingValuePending(true);
             const data = await calcHandler(calcParams);
             setCalcData({
-                ...data,
+                from_currency: data.from_currency,
+                to_currency: data.to_currency,
+                from_amount: data.from_amount,
+                result_amount: data.result_amount,
+                rate: data.rate,
+                fees: data.fees,
+                comission: data.comission,
+                network_fee: data.network_fee,
+                transaction_fee: data.transaction_fee,
+                from_symbol: data.from_symbol,
                 is_reverse,
                 is_subtract,
             });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.36.25",
+  "version": "1.36.27",
   "description": "Squarefi BFF API client module",
   "type": "module",
   "main": "./dist/index.js",