squarefi-bff-api-module 1.3.0 → 1.4.0

package/README.md

@@ -1,36 +1,120 @@
 # Squarefi BFF API Module
 
-A TypeScript/JavaScript client for interacting with the Squarefi BFF API.
+A professional TypeScript/JavaScript SDK for seamless integration with Squarefi BFF API.
 
-## Installation
+## 📦 Installation
 
 ```bash
 npm install squarefi-bff-api-module
 ```
 
-## Usage
+## 🔧 Usage
 
 ```typescript
-import { createApiClient } from 'squarefi-bff-api-module';
+import { squarefi_bff_api_client } from 'squarefi-bff-api-module';
 
-const api = createApiClient({
-  baseURL: 'YOUR_API_BASE_URL',
-  tenantId: 'YOUR_TENANT_ID',
-  isBearerToken: true,
-});
+// Authentication
+await squarefi_bff_api_client.auth.login(credentials);
 
-// Make API calls
-const response = await api.getRequest('/some-endpoint');
+// Exchange operations
+const rates = await squarefi_bff_api_client.exchange.getRates();
+
+// Tenant operations
+const tenantInfo = await squarefi_bff_api_client.tenants.getTenantInfo();
+
+// Wallet operations
+const balance = await squarefi_bff_api_client.wallets.getBalance();
+
+// Fiat accounts
+const accounts = await squarefi_bff_api_client.fiat_accounts.getAccounts();
 ```
 
-## Features
+## 📚 Available API Modules
+
+Access different API functionalities through the client:
+
+- `squarefi_bff_api_client.auth` - Authentication and authorization
+- `squarefi_bff_api_client.exchange` - Currency exchange operations
+- `squarefi_bff_api_client.fiat_accounts` - Fiat account management
+- `squarefi_bff_api_client.issuing` - Card issuing operations
+- `squarefi_bff_api_client.kyc` - Know Your Customer procedures
+- `squarefi_bff_api_client.list` - Listing and pagination utilities
+- `squarefi_bff_api_client.orders` - Order management
+- `squarefi_bff_api_client.tenants` - Tenant management operations
+- `squarefi_bff_api_client.user` - User profile operations
+- `squarefi_bff_api_client.wallets` - Crypto wallet operations
+
+## ⚙️ Environment Variables
+
+| Variable   | Description                       | Required | Example              |
+| ---------- | --------------------------------- | -------- | -------------------- |
+| API_URL    | Base URL for the Squarefi BFF API | Yes      | `https://api-v1.url` |
+| API_V2_URL | Base URL for the Squarefi BFF API | Yes      | `https://api-v2.url` |
+| TENANT_ID  | Your tenant identifier            | Yes      | `tenant_12345`       |
+
+## 🚀 Features
+
+- 🔒 Built-in token management and authentication
+- 📱 Telegram integration support
+- 💪 Full TypeScript support with strict typing
+- 🔄 Axios-based HTTP client
+- 📦 Comprehensive constants and types
+- 🛡️ Secure request handling
+- 🔑 Multi-tenant support
+
+## 🛠️ Development
+
+### Prerequisites
+
+- Node.js (Latest LTS version)
+- npm or yarn
+
+### Setup
+
+```bash
+# Install dependencies
+npm install
+
+# Build the package
+npm run build
+
+# Run tests
+npm test
+```
+
+## 🔐 Security
+
+The module implements industry-standard security practices:
+
+- Secure token management
+- Request signing
+- Rate limiting protection
+- HTTPS enforcement
+- Multi-tenant isolation
+
+## Dependencies
+
+### Main Dependencies
+
+- axios: 1.6.7
+- @telegram-apps/sdk-react: 3.1.2
+
+### Peer Dependencies
+
+- react: ^18.x.x
+
+## 📚 API Documentation
+
+Each module provides a set of type-safe methods for interacting with specific API endpoints. For detailed API documentation, please refer to our [API Documentation](link-to-your-docs).
+
+## 🆘 Support
+
+For support and questions, please [open an issue](link-to-issues) or contact our support team.
+
+## 🤝 Contributing
 
-- Full TypeScript support
-- Axios-based HTTP client
-- Token management
-- Telegram integration support
-- Comprehensive constants and types
+We welcome contributions! Please see our [Contributing Guide](link-to-contributing) for details.
 
-## License
+## 📄 License
 
 MIT

package/dist/api/index.d.ts

@@ -22,5 +22,5 @@ type Api = {
     user: typeof user;
     wallets: typeof wallets;
 };
-export declare const squarefiBffApiClient: Api;
+export declare const squarefi_bff_api_client: Api;
 export {};

package/dist/api/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.squarefiBffApiClient = void 0;
+exports.squarefi_bff_api_client = void 0;
 const auth_1 = require("./auth");
 const developer_1 = require("./developer");
 const exchange_1 = require("./exchange");
@@ -12,7 +12,7 @@ const orders_1 = require("./orders");
 const tenants_1 = require("./tenants");
 const user_1 = require("./user");
 const wallets_1 = require("./wallets");
-exports.squarefiBffApiClient = {
+exports.squarefi_bff_api_client = {
     auth: auth_1.auth,
     developer: developer_1.developer,
     exchange: exchange_1.exchange,

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export * from './api';
+export { squarefi_bff_api_client } from './api';
 export * from './utils/apiClientFactory';
 export * from './utils/tokensFactory';
 export * from './constants';

package/dist/index.js

@@ -14,7 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./api"), exports);
+exports.squarefi_bff_api_client = void 0;
+var api_1 = require("./api");
+Object.defineProperty(exports, "squarefi_bff_api_client", { enumerable: true, get: function () { return api_1.squarefi_bff_api_client; } });
 __exportStar(require("./utils/apiClientFactory"), exports);
 __exportStar(require("./utils/tokensFactory"), exports);
 __exportStar(require("./constants"), exports);

package/package.json

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

package/src/api/index.ts

@@ -24,7 +24,7 @@ type Api = {
   wallets: typeof wallets;
 };
 
-export const squarefiBffApiClient: Api = {
+export const squarefi_bff_api_client: Api = {
   auth,
   developer,
   exchange,

package/src/index.ts

@@ -1,4 +1,4 @@
-export * from './api';
+export { squarefi_bff_api_client } from './api';
 export * from './utils/apiClientFactory';
 export * from './utils/tokensFactory';
 export * from './constants';