@payark/sdk-effect 0.1.6 → 1.0.0-rc.1
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 +9 -10
- package/dist/api-spec.d.mts +385 -38
- package/dist/api-spec.d.ts +385 -38
- package/dist/api-spec.js +235 -15
- package/dist/api-spec.js.map +1 -1
- package/dist/api-spec.mjs +227 -16
- package/dist/api-spec.mjs.map +1 -1
- package/dist/index.d.mts +919 -99
- package/dist/index.d.ts +919 -99
- package/dist/index.js +615 -23
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +601 -25
- package/dist/index.mjs.map +1 -1
- package/dist/schemas.d.mts +90 -13
- package/dist/schemas.d.ts +90 -13
- package/dist/schemas.js +95 -5
- package/dist/schemas.js.map +1 -1
- package/dist/schemas.mjs +89 -6
- package/dist/schemas.mjs.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @payark/sdk-effect
|
|
2
2
|
|
|
3
|
-
A high-performance, functional TypeScript SDK for [PayArk](https://payark
|
|
3
|
+
A high-performance, functional TypeScript SDK for [PayArk](https://payark.dev/), built natively on the [Effect](https://effect.website/) ecosystem.
|
|
4
4
|
|
|
5
5
|
> **Native Effect** · **Type-safe** · **Runtime Validation** · **Zero Promise overhead** · **Branded Types**
|
|
6
6
|
|
|
@@ -81,8 +81,7 @@ const program = Effect.gen(function* (_) {
|
|
|
81
81
|
|
|
82
82
|
// Configure the layer
|
|
83
83
|
const PayArkLive = PayArk.Live({
|
|
84
|
-
apiKey:
|
|
85
|
-
sandbox: true, // Enable sandbox mode
|
|
84
|
+
apiKey: "sk_test_...", // Use sk_test_ for Sandbox, sk_live_ for Production
|
|
86
85
|
});
|
|
87
86
|
|
|
88
87
|
// Provide the layer to the program
|
|
@@ -95,13 +94,13 @@ Effect.runPromise(runnable);
|
|
|
95
94
|
|
|
96
95
|
The `PayArkConfig` object accepts:
|
|
97
96
|
|
|
98
|
-
| Option | Type | Default
|
|
99
|
-
| ------------ | --------- |
|
|
100
|
-
| `apiKey` | `string` | **Required**
|
|
101
|
-
| `sandbox` | `boolean` | `false`
|
|
102
|
-
| `baseUrl` | `string` | `
|
|
103
|
-
| `timeout` | `number` | `30000`
|
|
104
|
-
| `maxRetries` | `number` | `2`
|
|
97
|
+
| Option | Type | Default | Description |
|
|
98
|
+
| ------------ | --------- | ---------------- | ------------------------------------------------------------------------------------------------ |
|
|
99
|
+
| `apiKey` | `string` | **Required** | Your project's secret key (`sk_test_...` or `sk_live_...`). Environment is detected from prefix. |
|
|
100
|
+
| `sandbox` | `boolean` | `false` | Optional explicit Sandbox Mode override. Mostly unnecessary when using `sk_test_`. |
|
|
101
|
+
| `baseUrl` | `string` | `api.payark.dev` | Override for local dev or proxy. |
|
|
102
|
+
| `timeout` | `number` | `30000` | Request timeout in ms. |
|
|
103
|
+
| `maxRetries` | `number` | `2` | Automatic retries on 5xx errors. |
|
|
105
104
|
|
|
106
105
|
## Branded Types & Validation
|
|
107
106
|
|