@eaera-com/client-sdk-v1 0.2.109 → 0.2.110
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +0 -86
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,86 +0,0 @@
|
|
|
1
|
-
# client-sdk-v1
|
|
2
|
-
|
|
3
|
-
## Installation
|
|
4
|
-
|
|
5
|
-
```bash
|
|
6
|
-
npm install @eaera-com/client-sdk-v1
|
|
7
|
-
# or
|
|
8
|
-
yarn add @eaera-com/client-sdk-v1
|
|
9
|
-
```
|
|
10
|
-
|
|
11
|
-
## Usage
|
|
12
|
-
|
|
13
|
-
### Import Constants (Tree-shakeable)
|
|
14
|
-
|
|
15
|
-
For optimal bundle size, import constants directly from specific files:
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
// ✅ Recommended: Import from specific files
|
|
19
|
-
import { CATEGORY_NAME } from '@eaera-com/client-sdk-v1/constants/category.constant';
|
|
20
|
-
import { PSP, PSP_TEXT } from '@eaera-com/client-sdk-v1/constants/methods.constant';
|
|
21
|
-
import { TRANSACTION_STATE } from '@eaera-com/client-sdk-v1/constants/transaction.constant';
|
|
22
|
-
import { KYC_STATE } from '@eaera-com/client-sdk-v1/constants/kyc.constant';
|
|
23
|
-
```
|
|
24
|
-
|
|
25
|
-
### Import Types (Tree-shakeable)
|
|
26
|
-
|
|
27
|
-
```typescript
|
|
28
|
-
// ✅ Recommended: Import from specific files
|
|
29
|
-
import { FundingSourcePayload } from '@eaera-com/client-sdk-v1/types/fundingSource.type';
|
|
30
|
-
import { CategoryName } from '@eaera-com/client-sdk-v1/types/category.type';
|
|
31
|
-
import { Wallet, Currency } from '@eaera-com/client-sdk-v1/types/wallet.type';
|
|
32
|
-
```
|
|
33
|
-
|
|
34
|
-
### Import Utilities
|
|
35
|
-
|
|
36
|
-
```typescript
|
|
37
|
-
// Import helpers
|
|
38
|
-
import { formatCurrency, formatNumber } from '@eaera-com/client-sdk-v1/use-utils/helpers';
|
|
39
|
-
|
|
40
|
-
// Import validators
|
|
41
|
-
import { validateInputAmount } from '@eaera-com/client-sdk-v1/use-utils/validators';
|
|
42
|
-
|
|
43
|
-
// Import full SDK class
|
|
44
|
-
import { UseUtilsSDK } from '@eaera-com/client-sdk-v1/use-utils/sdk';
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## Available Subpath Exports
|
|
48
|
-
|
|
49
|
-
### Constants
|
|
50
|
-
|
|
51
|
-
- `constants/category.constant`
|
|
52
|
-
- `constants/communication.constant`
|
|
53
|
-
- `constants/filter.constants`
|
|
54
|
-
- `constants/kyc.constant`
|
|
55
|
-
- `constants/listStatus.constants`
|
|
56
|
-
- `constants/methods.constant`
|
|
57
|
-
- `constants/program.constants`
|
|
58
|
-
- `constants/store.constants`
|
|
59
|
-
- `constants/supportTicket.constant`
|
|
60
|
-
- `constants/transaction.constant`
|
|
61
|
-
- `constants/type.constants`
|
|
62
|
-
- `constants/withdraw.constant`
|
|
63
|
-
|
|
64
|
-
### Types
|
|
65
|
-
|
|
66
|
-
- `types/category.type`
|
|
67
|
-
- `types/communication.type`
|
|
68
|
-
- `types/email.type`
|
|
69
|
-
- `types/fundingSource.type`
|
|
70
|
-
- `types/liveNotification.type`
|
|
71
|
-
- `types/siteSetting.type`
|
|
72
|
-
- `types/wallet.type`
|
|
73
|
-
|
|
74
|
-
### Utilities
|
|
75
|
-
|
|
76
|
-
- `use-utils` - Main utilities SDK
|
|
77
|
-
- `use-utils/helpers` - All helper functions
|
|
78
|
-
- `use-utils/validators` - Validation functions
|
|
79
|
-
- `use-utils/sdk` - Full SDK class
|
|
80
|
-
|
|
81
|
-
## Benefits
|
|
82
|
-
|
|
83
|
-
- ✅ **Tree-shaking**: Only bundle what you import
|
|
84
|
-
- ✅ **Smaller bundle size**: Import specific constants/types instead of everything
|
|
85
|
-
- ✅ **Better performance**: Faster build times and smaller production bundles
|
|
86
|
-
- ✅ **Type-safe**: Full TypeScript support
|