squarefi-bff-api-module 1.23.5 → 1.24.1

package/CHANGELOG.md

@@ -5,6 +5,192 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.25.0] - 2025-07-23
+
+### Changed
+
+- Enhanced refresh token handling for Telegram sign-in methods in TMA
+- Updated Telegram auth types to use request/response structures for improved type safety with optional refresh_token
+
+### Added
+
+- Improved Telegram authentication workflow with better token management
+
+## [1.24.0] - 2025-07-23
+
+### Changed
+
+- Version release for accumulated features
+
+## [1.23.5] - 2025-07-22
+
+### Added
+
+- Additional optional fields to meta for enhanced transaction details
+
+## [1.23.4] - 2025-07-22
+
+### Changed
+
+- Made account_number, routing_number, and swift_bic optional in ExternalBankingData for improved flexibility
+
+## [1.23.3] - 2025-07-22
+
+### Added
+
+- Optional state field to address type for improved address detail accuracy
+
+## [1.23.2] - 2025-07-22
+
+### Added
+
+- Added state_id to address type for enhanced address details
+
+## [1.23.1] - 2025-07-22
+
+### Added
+
+- States API endpoint and related types for fetching states by country_id
+
+## [1.23.0] - 2025-07-22
+
+### Fixed
+
+- Updated Counterparty and related DTOs to require email and phone fields for improved data integrity
+- Added note to orderRequests
+
+## [1.22.13] - 2025-07-21
+
+### Fixed
+
+- Corrected Confirm.Request type to reference changeEmailConfirm operation for accurate API request handling
+
+## [1.22.12] - 2025-07-20
+
+### Added
+
+- PROCESSING status to OrderStatuses enum for enhanced order tracking
+
+## [1.22.11] - 2025-07-20
+
+### Fixed
+
+- Updated WithdrawCryptoRequest to include SEGREGATED_CRYPTO_TRANSFER in order_type for improved transaction handling
+
+## [1.22.10] - 2025-07-20
+
+### Added
+
+- SEGREGATED_CRYPTO_TRANSFER to WalletTransactionRecordType enum for expanded transaction support
+
+## [1.22.9] - 2025-07-20
+
+### Added
+
+- SEGREGATED_CRYPTO_TRANSFER order type and corresponding request/response types for enhanced order processing
+
+## [1.22.8] - 2025-07-18
+
+### Changed
+
+- Streamlined user phone and email request types by leveraging OpenAPI operations for improved type safety and maintainability
+
+## [1.22.7] - 2025-07-18
+
+### Added
+
+- wallet_id to pagination request in VirtualAccountPrograms Request
+- wallet_id to issuing_programs request
+
+## [1.22.6] - 2025-07-18
+
+### Added
+
+- Optional birth_date field to user types in API schema for enhanced user data handling
+
+## [1.22.5] - 2025-07-18
+
+### Changed
+
+- Updated user and userData types to align with new API schema
+- Enhanced type safety in user requests
+
+## [1.22.4] - 2025-07-18
+
+### Added
+
+- New OrderTypeKycRail type and updated OrderInfo structure
+
+### Changed
+
+- Removed deprecated kyc_rails_id
+
+## [1.22.3] - 2025-07-18
+
+### Fixed
+
+- Made limits property optional in card configuration for flexibility
+
+## [1.22.2] - 2025-07-05
+
+### Added
+
+- Exported hooks from the hooks module for improved functionality
+
+## [1.22.1] - 2025-07-04
+
+### Added
+
+- useCalc hook for enhanced calculation functionality
+
+## [1.22.0] - 2025-07-04
+
+### Fixed
+
+- Renamed currency_id to from_currency_id in request parameters for clarity
+
+## [1.21.9] - 2025-06-26
+
+### Fixed
+
+- Renamed currency parameters in Calc.CommonRequestParams to use IDs for improved clarity
+
+## [1.21.8] - 2025-06-25
+
+### Fixed
+
+- Updated orderType request params to include to_currency
+
+## [1.21.7] - 2025-06-24
+
+### Added
+
+- HIFI_CRYPTO_TRANSFER order type with request and response types for enhanced order processing
+
+## [1.21.6] - 2025-06-24
+
+### Added
+
+- New wallet transaction record types for enhanced transaction handling
+
+## [1.21.5] - 2025-06-24
+
+### Added
+
+- count property to TransactionsList interface for improved transaction data handling
+
+## [1.21.4] - 2025-06-23
+
+### Changed
+
+- Refactored getAll method in issuing API to accept parameters as an object and updated types for improved flexibility
+
+## [1.21.3] - 2025-06-23
+
+### Added
+
+- TBD_SWIFT_WITHDRAWAL order type with request and response types
+
 ## [1.21.2] - 2025-06-17
 
 ### Added

package/dist/api/auth.d.ts

@@ -14,14 +14,14 @@ export declare const auth: {
             email: (data: API.Auth.SignIn.Email.OTP.Request) => Promise<API.Auth.Tokens>;
             phone: ({ phone, ...data }: API.Auth.SignIn.Phone.OTP.Request) => Promise<API.Auth.Tokens>;
         };
-        telegram: (data: API.Auth.Telegram.Signin) => Promise<API.Auth.Tokens>;
+        telegram: (data: API.Auth.Telegram.Signin.Request) => Promise<API.Auth.Telegram.Signin.Response>;
         password: (email: string, password: string) => Promise<API.Auth.Tokens>;
     };
     signup: {
         password: (email: string, password: string) => Promise<API.Auth.Tokens>;
-        telegram: (data: API.Auth.Telegram.Signup) => Promise<API.Auth.Tokens>;
+        telegram: (data: API.Auth.Telegram.Signup.Request) => Promise<API.Auth.Telegram.Signup.Response>;
     };
     refresh: {
-        refresh_token: (refresh_token: string) => Promise<API.Auth.Tokens>;
+        refresh_token: (data: API.Auth.RefreshToken.Request) => Promise<API.Auth.RefreshToken.Response>;
     };
 };

package/dist/api/auth.js

@@ -52,6 +52,6 @@ exports.auth = {
         telegram: (data) => apiClientFactory_1.apiClientV2.postRequest(exports.telegramSignUpPath, { data }),
     },
     refresh: {
-        refresh_token: (refresh_token) => apiClientFactory_1.apiClientV2.postRequest(exports.refreshTokenPath, { data: { refresh_token } }),
+        refresh_token: (data) => apiClientFactory_1.apiClientV2.postRequest(exports.refreshTokenPath, { data }),
     },
 };

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

@@ -3,22 +3,18 @@ import { WalletType } from '../..';
 import { components, operations } from './autogen/apiV2.types';
 export declare namespace API {
     namespace Auth {
+        namespace RefreshToken {
+            type Request = operations['AuthController_refreshToken']['requestBody']['content']['application/json'];
+            type Response = operations['AuthController_refreshToken']['responses']['200']['content']['application/json'];
+        }
         namespace Telegram {
-            interface Signin {
-                tg_id: number;
-                hash: string;
-                init_data_raw: string;
+            namespace Signin {
+                type Request = operations['AuthTelegramController_signIn']['requestBody']['content']['application/json'];
+                type Response = operations['AuthTelegramController_signIn']['responses']['200']['content']['application/json'];
             }
-            interface Signup {
-                phone: string;
-                tg_id: number;
-                first_name: string;
-                last_name?: string;
-                hash: string;
-                init_data_raw: string;
-                referrer?: string;
-                invite_code?: string;
-                username: string;
+            namespace Signup {
+                type Request = operations['AuthTelegramController_signUp']['requestBody']['content']['application/json'];
+                type Response = operations['AuthTelegramController_signUp']['responses']['200']['content']['application/json'];
             }
         }
         interface Tokens {

package/dist/utils/apiClientFactory.js

@@ -55,7 +55,7 @@ const createApiClient = ({ baseURL, isBearerToken, tenantId }) => {
     let isTokenRefreshing = false;
     let requestQueue = [];
     instance.interceptors.response.use((response) => response, (error) => {
-        var _a, _b;
+        var _a, _b, _c, _d;
         if (typeof window === 'undefined') {
             return Promise.reject(error);
         }
@@ -64,9 +64,25 @@ const createApiClient = ({ baseURL, isBearerToken, tenantId }) => {
             const refreshToken = (0, storage_1.getFromLocalStorage)('refresh_token');
             const isRetryRequest = failedRequest.headers['X-Retry-Request'];
             const isRefreshTokenRequest = (_b = response === null || response === void 0 ? void 0 : response.config) === null || _b === void 0 ? void 0 : _b.url.includes(auth_1.refreshTokenPath);
-            const isRefreshNotRequired = !refreshToken;
-            const isLogoutNeccesary = isRefreshNotRequired || isRefreshTokenRequest || isRetryRequest;
-            const isRefreshAvailable = (!isTokenRefreshing && typeof refreshToken === 'string') || (0, sdk_react_1.isTMA)();
+            const isTelegramSignInRequest = (_c = response === null || response === void 0 ? void 0 : response.config) === null || _c === void 0 ? void 0 : _c.url.includes(auth_1.telegramSignInPath);
+            const isTelegramSignUpRequest = (_d = response === null || response === void 0 ? void 0 : response.config) === null || _d === void 0 ? void 0 : _d.url.includes(auth_1.telegramSignUpPath);
+            const isRefreshNotRequired = !refreshToken && !(0, sdk_react_1.isTMA)();
+            const isLogoutNeccesary = isRefreshNotRequired ||
+                isTelegramSignInRequest ||
+                isTelegramSignUpRequest ||
+                isRefreshTokenRequest ||
+                isRetryRequest;
+            const isRefreshAvailable = !isTokenRefreshing && !isRefreshNotRequired;
+            console.log('isRefreshAvailable', isRefreshAvailable);
+            console.log('isLogoutNeccesary', isLogoutNeccesary);
+            console.log('isRetryRequest', isRetryRequest);
+            console.log('isTelegramSignInRequest', isTelegramSignInRequest);
+            console.log('isTelegramSignUpRequest', isTelegramSignUpRequest);
+            console.log('isRefreshTokenRequest', isRefreshTokenRequest);
+            console.log('isRefreshNotRequired', isRefreshNotRequired);
+            console.log('isTokenRefreshing', isTokenRefreshing);
+            console.log('refreshToken', refreshToken);
+            console.log('isTMA', (0, sdk_react_1.isTMA)());
             if (isLogoutNeccesary) {
                 if (typeof window !== 'undefined') {
                     window.location.href = envLogoutURL;
@@ -76,6 +92,7 @@ const createApiClient = ({ baseURL, isBearerToken, tenantId }) => {
                 return Promise.reject(response);
             }
             if (isRefreshAvailable) {
+                isTokenRefreshing = true;
                 (0, tokensFactory_1.refreshTokens)()
                     .then((data) => {
                     if (data === null || data === void 0 ? void 0 : data.access_token) {

package/dist/utils/tokensFactory.d.ts

@@ -1,10 +1,10 @@
-type SetTokensProps = {
+type ITokens = {
     access_token: string;
-    refresh_token?: string;
+    refresh_token?: string | null;
 };
-export declare function setTokens({ access_token, refresh_token }: SetTokensProps): void;
+export declare function setTokens({ access_token, refresh_token }: ITokens): void;
 export declare function deleteTokens(): void;
-export declare function refreshTokens(): Promise<import("..").API.Auth.Tokens | null>;
+export declare function refreshTokens(): Promise<ITokens | null>;
 export declare function getTokens(): {
     access_token: string | null;
     refresh_token: string | null;

package/dist/utils/tokensFactory.js

@@ -13,6 +13,7 @@ exports.setTokens = setTokens;
 exports.deleteTokens = deleteTokens;
 exports.refreshTokens = refreshTokens;
 exports.getTokens = getTokens;
+const sdk_react_1 = require("@telegram-apps/sdk-react");
 const storage_1 = require("./storage");
 const auth_1 = require("../api/auth");
 function setTokens({ access_token, refresh_token }) {
@@ -25,13 +26,29 @@ function deleteTokens() {
 }
 function refreshTokens() {
     return __awaiter(this, void 0, void 0, function* () {
-        const refreshToken = (0, storage_1.getFromLocalStorage)('refresh_token');
-        if (!refreshToken) {
-            return null;
+        var _a;
+        const refresh_token = (0, storage_1.getFromLocalStorage)('refresh_token');
+        if (refresh_token) {
+            const refreshResponse = yield auth_1.auth.refresh.refresh_token({ refresh_token });
+            setTokens(refreshResponse);
+            return refreshResponse;
         }
-        const tokens = yield auth_1.auth.refresh.refresh_token(refreshToken);
-        setTokens(tokens);
-        return tokens;
+        if ((0, sdk_react_1.isTMA)()) {
+            const tg_id = (_a = sdk_react_1.initData.user()) === null || _a === void 0 ? void 0 : _a.id;
+            const hash = sdk_react_1.initData.hash();
+            const init_data_raw = sdk_react_1.initData.raw();
+            if (!tg_id || !hash || !init_data_raw) {
+                return null;
+            }
+            const telegramSignInResponse = yield auth_1.auth.signin.telegram({
+                tg_id: tg_id.toString(),
+                hash,
+                init_data_raw,
+            });
+            setTokens(telegramSignInResponse);
+            return telegramSignInResponse;
+        }
+        return null;
     });
 }
 function getTokens() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "squarefi-bff-api-module",
-  "version": "1.23.5",
+  "version": "1.24.1",
   "description": "Squarefi BFF API client module",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package/src/api/auth.ts

@@ -31,8 +31,8 @@ export const auth = {
           data: { phone: convertPhoneToSupabaseFormat(phone), ...data },
         }),
     },
-    telegram: (data: API.Auth.Telegram.Signin): Promise<API.Auth.Tokens> =>
-      apiClientV2.postRequest<API.Auth.Tokens>(telegramSignInPath, { data }),
+    telegram: (data: API.Auth.Telegram.Signin.Request): Promise<API.Auth.Telegram.Signin.Response> =>
+      apiClientV2.postRequest<API.Auth.Telegram.Signin.Response>(telegramSignInPath, { data }),
     password: (
       email: string,
       password: string // check on backend V2
@@ -46,11 +46,11 @@ export const auth = {
       apiClientV2.postRequest<API.Auth.Tokens>('/auth/sign-up/password/email', {
         data: { email, password },
       }),
-    telegram: (data: API.Auth.Telegram.Signup): Promise<API.Auth.Tokens> =>
-      apiClientV2.postRequest<API.Auth.Tokens>(telegramSignUpPath, { data }),
+    telegram: (data: API.Auth.Telegram.Signup.Request): Promise<API.Auth.Telegram.Signup.Response> =>
+      apiClientV2.postRequest<API.Auth.Telegram.Signup.Response>(telegramSignUpPath, { data }),
   },
   refresh: {
-    refresh_token: (refresh_token: string): Promise<API.Auth.Tokens> =>
-      apiClientV2.postRequest<API.Auth.Tokens>(refreshTokenPath, { data: { refresh_token } }),
+    refresh_token: (data: API.Auth.RefreshToken.Request): Promise<API.Auth.RefreshToken.Response> =>
+      apiClientV2.postRequest<API.Auth.RefreshToken.Response>(refreshTokenPath, { data }),
   },
 };

package/src/api/types/types.ts

@@ -23,22 +23,21 @@ import { components, operations } from './autogen/apiV2.types';
 
 export namespace API {
   export namespace Auth {
+    export namespace RefreshToken {
+      export type Request = operations['AuthController_refreshToken']['requestBody']['content']['application/json'];
+      export type Response =
+        operations['AuthController_refreshToken']['responses']['200']['content']['application/json'];
+    }
     export namespace Telegram {
-      export interface Signin {
-        tg_id: number;
-        hash: string;
-        init_data_raw: string;
+      export namespace Signin {
+        export type Request = operations['AuthTelegramController_signIn']['requestBody']['content']['application/json'];
+        export type Response =
+          operations['AuthTelegramController_signIn']['responses']['200']['content']['application/json'];
       }
-      export interface Signup {
-        phone: string;
-        tg_id: number;
-        first_name: string;
-        last_name?: string;
-        hash: string;
-        init_data_raw: string;
-        referrer?: string;
-        invite_code?: string;
-        username: string;
+      export namespace Signup {
+        export type Request = operations['AuthTelegramController_signUp']['requestBody']['content']['application/json'];
+        export type Response =
+          operations['AuthTelegramController_signUp']['responses']['200']['content']['application/json'];
       }
     }
 

package/src/utils/apiClientFactory.ts

@@ -67,10 +67,27 @@ export const createApiClient = ({ baseURL, isBearerToken, tenantId }: CreateApiC
         const isRetryRequest = failedRequest.headers['X-Retry-Request'];
 
         const isRefreshTokenRequest = response?.config?.url.includes(refreshTokenPath);
-        const isRefreshNotRequired = !refreshToken;
-        const isLogoutNeccesary = isRefreshNotRequired || isRefreshTokenRequest || isRetryRequest;
-
-        const isRefreshAvailable = (!isTokenRefreshing && typeof refreshToken === 'string') || isTMA();
+        const isTelegramSignInRequest = response?.config?.url.includes(telegramSignInPath);
+        const isTelegramSignUpRequest = response?.config?.url.includes(telegramSignUpPath);
+        const isRefreshNotRequired = !refreshToken && !isTMA();
+        const isLogoutNeccesary =
+          isRefreshNotRequired ||
+          isTelegramSignInRequest ||
+          isTelegramSignUpRequest ||
+          isRefreshTokenRequest ||
+          isRetryRequest;
+
+        const isRefreshAvailable = !isTokenRefreshing && !isRefreshNotRequired;
+        console.log('isRefreshAvailable', isRefreshAvailable);
+        console.log('isLogoutNeccesary', isLogoutNeccesary);
+        console.log('isRetryRequest', isRetryRequest);
+        console.log('isTelegramSignInRequest', isTelegramSignInRequest);
+        console.log('isTelegramSignUpRequest', isTelegramSignUpRequest);
+        console.log('isRefreshTokenRequest', isRefreshTokenRequest);
+        console.log('isRefreshNotRequired', isRefreshNotRequired);
+        console.log('isTokenRefreshing', isTokenRefreshing);
+        console.log('refreshToken', refreshToken);
+        console.log('isTMA', isTMA());
 
         if (isLogoutNeccesary) {
           if (typeof window !== 'undefined') {
@@ -81,6 +98,7 @@ export const createApiClient = ({ baseURL, isBearerToken, tenantId }: CreateApiC
           return Promise.reject(response);
         }
         if (isRefreshAvailable) {
+          isTokenRefreshing = true;
           refreshTokens()
             .then((data) => {
               if (data?.access_token) {

package/src/utils/tokensFactory.ts

@@ -1,13 +1,16 @@
+import { initData, isTMA } from '@telegram-apps/sdk-react';
+
 import { deleteFromLocalStorage, getFromLocalStorage, setToLocalStorage } from './storage';
 
 import { auth } from '../api/auth';
+import { API } from '../api/types/types';
 
-type SetTokensProps = {
+type ITokens = {
   access_token: string;
-  refresh_token?: string;
+  refresh_token?: string | null;
 };
 
-export function setTokens({ access_token, refresh_token }: SetTokensProps) {
+export function setTokens({ access_token, refresh_token }: ITokens) {
   access_token && setToLocalStorage('access_token', access_token);
   refresh_token && setToLocalStorage('refresh_token', refresh_token);
 }
@@ -17,18 +20,36 @@ export function deleteTokens() {
   deleteFromLocalStorage('refresh_token');
 }
 
-export async function refreshTokens() {
-  const refreshToken = getFromLocalStorage('refresh_token');
+export async function refreshTokens(): Promise<ITokens | null> {
+  const refresh_token = getFromLocalStorage('refresh_token');
+
+  if (refresh_token) {
+    const refreshResponse = await auth.refresh.refresh_token({ refresh_token });
 
-  if (!refreshToken) {
-    return null;
+    setTokens(refreshResponse);
+    return refreshResponse;
   }
 
-  const tokens = await auth.refresh.refresh_token(refreshToken);
+  if (isTMA()) {
+    const tg_id = initData.user()?.id;
+    const hash = initData.hash();
+    const init_data_raw = initData.raw();
+
+    if (!tg_id || !hash || !init_data_raw) {
+      return null;
+    }
 
-  setTokens(tokens);
+    const telegramSignInResponse = await auth.signin.telegram({
+      tg_id: tg_id.toString(),
+      hash,
+      init_data_raw,
+    });
+
+    setTokens(telegramSignInResponse);
+    return telegramSignInResponse;
+  }
 
-  return tokens;
+  return null;
 }
 
 export function getTokens() {