@carts1024/velo-sdk 0.1.0-alpha.1 → 0.1.0-alpha.2
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/CHANGELOG.md +6 -1
- package/README.md +8 -8
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to the Velo SDK will be documented in this file.
|
|
4
4
|
|
|
5
|
-
## [0.1.0-alpha.
|
|
5
|
+
## [0.1.0-alpha.2] - 2026-07-02
|
|
6
6
|
|
|
7
7
|
### Added
|
|
8
8
|
|
|
@@ -12,3 +12,8 @@ All notable changes to the Velo SDK will be documented in this file.
|
|
|
12
12
|
- **Webhook Verification**: Secure HMAC-SHA256 signature validation with clock skew/tolerance checking using `Velo.webhooks.verify()`.
|
|
13
13
|
- **Typed Errors**: Custom error classes (`VeloAPIError`, `VeloAuthError`, `VeloRateLimitError`, `VeloValidationError`) matching API status codes.
|
|
14
14
|
- **Idempotency**: Support for client-supplied `Idempotency-Key` headers on payment session creation.
|
|
15
|
+
- **E2E Tests**: End-to-end test suite verifying payment flows.
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
|
|
19
|
+
- **Package Rename**: Renamed package from `@velo/sdk` to `@carts1024/velo-sdk` and updated examples and documentation.
|
package/README.md
CHANGED
|
@@ -3,16 +3,16 @@
|
|
|
3
3
|
The official Velo SDK for Node.js and modern JavaScript environments.
|
|
4
4
|
|
|
5
5
|
> [!NOTE]
|
|
6
|
-
> This package is currently in **Alpha** (`0.1.0-alpha.
|
|
6
|
+
> This package is currently in **Alpha** (`0.1.0-alpha.2`) and is meant for server-side environments only.
|
|
7
7
|
|
|
8
8
|
## Installation
|
|
9
9
|
|
|
10
10
|
```bash
|
|
11
|
-
npm install @velo
|
|
11
|
+
npm install @carts1024/velo-sdk
|
|
12
12
|
# or
|
|
13
|
-
pnpm add @velo
|
|
13
|
+
pnpm add @carts1024/velo-sdk
|
|
14
14
|
# or
|
|
15
|
-
yarn add @velo
|
|
15
|
+
yarn add @carts1024/velo-sdk
|
|
16
16
|
```
|
|
17
17
|
|
|
18
18
|
## Getting Started
|
|
@@ -20,7 +20,7 @@ yarn add @velo/sdk
|
|
|
20
20
|
Initialize the client with your Velo API key:
|
|
21
21
|
|
|
22
22
|
```ts
|
|
23
|
-
import { Velo } from "@velo
|
|
23
|
+
import { Velo } from "@carts1024/velo-sdk";
|
|
24
24
|
|
|
25
25
|
const velo = new Velo({
|
|
26
26
|
apiKey: process.env.VELO_API_KEY!,
|
|
@@ -83,7 +83,7 @@ const event = await Velo.webhooks.verify({
|
|
|
83
83
|
|
|
84
84
|
```ts
|
|
85
85
|
import { NextResponse } from "next/server";
|
|
86
|
-
import { Velo } from "@velo
|
|
86
|
+
import { Velo } from "@carts1024/velo-sdk";
|
|
87
87
|
|
|
88
88
|
export async function POST(request: Request) {
|
|
89
89
|
// 1. Get the raw text payload (DO NOT call request.json())
|
|
@@ -134,7 +134,7 @@ Ensure you capture the raw body as a string. You can use `express.raw` middlewar
|
|
|
134
134
|
|
|
135
135
|
```ts
|
|
136
136
|
import express from "express";
|
|
137
|
-
import { Velo } from "@velo
|
|
137
|
+
import { Velo } from "@carts1024/velo-sdk";
|
|
138
138
|
|
|
139
139
|
const app = express();
|
|
140
140
|
|
|
@@ -205,7 +205,7 @@ Idempotency keys are scoped to your project. Repeating a request with the same p
|
|
|
205
205
|
## Testnet vs Mainnet & Alpha Limitations
|
|
206
206
|
|
|
207
207
|
> [!WARNING]
|
|
208
|
-
> This SDK is currently in **Alpha** (`0.1.0-alpha.
|
|
208
|
+
> This SDK is currently in **Alpha** (`0.1.0-alpha.2`) and subject to changes.
|
|
209
209
|
>
|
|
210
210
|
> - **Stellar Testnet Only**: During the alpha phase, all transactions and checkout sessions are routed through the Stellar Testnet. Mainnet is currently unsupported.
|
|
211
211
|
> - **ESM-Only**: The package uses ESM exports and requires `"type": "module"` or an ESM-compatible bundler/environment. CommonJS `require()` is not supported directly.
|