@putdotio/sdk 9.0.0 → 9.0.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 +8 -6
- package/dist/index.d.ts +652 -664
- package/dist/index.js +284 -303
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -22,8 +22,10 @@
|
|
|
22
22
|
|
|
23
23
|
## Installation
|
|
24
24
|
|
|
25
|
+
Install with your package manager of choice:
|
|
26
|
+
|
|
25
27
|
```bash
|
|
26
|
-
|
|
28
|
+
npm install @putdotio/sdk
|
|
27
29
|
```
|
|
28
30
|
|
|
29
31
|
## Promise Example
|
|
@@ -88,6 +90,9 @@ Effect is the canonical typed surface. The Promise client is an adapter for envi
|
|
|
88
90
|
|
|
89
91
|
- Effect client: keeps errors in the Effect error channel with operation-specific typing
|
|
90
92
|
- Promise client: throws tagged SDK error objects such as `PutioOperationError`, `PutioApiError`, and `PutioRateLimitError`
|
|
93
|
+
- Promise client: owns a managed Effect runtime and exposes `dispose()` for explicit teardown
|
|
94
|
+
|
|
95
|
+
If you create a long-lived Promise client in a script, test harness, or server integration, call `await sdk.dispose()` during teardown.
|
|
91
96
|
|
|
92
97
|
## Namespace Surface
|
|
93
98
|
|
|
@@ -254,6 +259,8 @@ export const useFiles = (parentId: number) =>
|
|
|
254
259
|
|
|
255
260
|
## Verification
|
|
256
261
|
|
|
262
|
+
Repo-local verification uses `vp`:
|
|
263
|
+
|
|
257
264
|
Local checks:
|
|
258
265
|
|
|
259
266
|
```bash
|
|
@@ -277,10 +284,5 @@ vp run verify
|
|
|
277
284
|
vp run bootstrap:tokens
|
|
278
285
|
```
|
|
279
286
|
|
|
280
|
-
## Release Flow
|
|
281
|
-
|
|
282
|
-
Pushes to `main` verify the repo and then run `semantic-release`.
|
|
283
|
-
Add `NPM_TOKEN` in GitHub secrets and use conventional commits to drive version bumps.
|
|
284
|
-
|
|
285
287
|
Implementation and confidence notes live in `docs/READINESS.md`.
|
|
286
288
|
Target-by-target live verification guidance lives in `docs/TESTING.md`.
|