@putdotio/sdk 9.1.0 → 9.1.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/README.md +27 -41
- package/dist/{index-BXhxIJsZ.d.ts → index-J_maUhU1.d.ts} +67 -67
- package/dist/index.d.ts +1 -1
- package/dist/index.js +10 -2
- package/dist/index.js.map +1 -1
- package/dist/utilities.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,23 +28,6 @@ Install with npm:
|
|
|
28
28
|
npm install @putdotio/sdk
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
## Utilities
|
|
32
|
-
|
|
33
|
-
Shared formatting, URL, and error-localization helpers are available from the utilities subpath:
|
|
34
|
-
|
|
35
|
-
```ts
|
|
36
|
-
import {
|
|
37
|
-
FileURLProvider,
|
|
38
|
-
secondsToReadableDuration,
|
|
39
|
-
toHumanFileSize,
|
|
40
|
-
} from "@putdotio/sdk/utilities";
|
|
41
|
-
```
|
|
42
|
-
|
|
43
|
-
```ts
|
|
44
|
-
const size = toHumanFileSize(1_572_864);
|
|
45
|
-
const duration = secondsToReadableDuration(444);
|
|
46
|
-
```
|
|
47
|
-
|
|
48
31
|
## Quick Start
|
|
49
32
|
|
|
50
33
|
```ts
|
|
@@ -67,6 +50,23 @@ const sdk = createPutioSdkPromiseClient();
|
|
|
67
50
|
const validation = await sdk.auth.validateToken(process.env.PUTIO_TOKEN!);
|
|
68
51
|
```
|
|
69
52
|
|
|
53
|
+
## Utilities
|
|
54
|
+
|
|
55
|
+
Shared formatting, URL, and error-localization helpers are available from the utilities subpath:
|
|
56
|
+
|
|
57
|
+
```ts
|
|
58
|
+
import {
|
|
59
|
+
FileURLProvider,
|
|
60
|
+
secondsToReadableDuration,
|
|
61
|
+
toHumanFileSize,
|
|
62
|
+
} from "@putdotio/sdk/utilities";
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
const size = toHumanFileSize(1_572_864);
|
|
67
|
+
const duration = secondsToReadableDuration(444);
|
|
68
|
+
```
|
|
69
|
+
|
|
70
70
|
## Effect Example
|
|
71
71
|
|
|
72
72
|
```ts
|
|
@@ -284,32 +284,18 @@ export const useFiles = (parentId: number) =>
|
|
|
284
284
|
});
|
|
285
285
|
```
|
|
286
286
|
|
|
287
|
-
##
|
|
288
|
-
|
|
289
|
-
If you are working on the SDK itself, repo-local verification uses `vp`:
|
|
290
|
-
|
|
291
|
-
Local checks:
|
|
292
|
-
|
|
293
|
-
```bash
|
|
294
|
-
vp install
|
|
295
|
-
vp check .
|
|
296
|
-
vp pack
|
|
297
|
-
vp test run --passWithNoTests
|
|
298
|
-
vp test run --coverage --passWithNoTests
|
|
299
|
-
```
|
|
287
|
+
## Docs
|
|
300
288
|
|
|
301
|
-
|
|
289
|
+
- [docs/ARCHITECTURE.md](./docs/ARCHITECTURE.md) for package shape and boundaries
|
|
290
|
+
- [docs/TESTING.md](./docs/TESTING.md) for local and live verification
|
|
291
|
+
- [docs/READINESS.md](./docs/READINESS.md) for domain readiness
|
|
292
|
+
- [docs/RELEASE.md](./docs/RELEASE.md) for release automation
|
|
293
|
+
- [SECURITY.md](./SECURITY.md) for private-first vulnerability disclosure
|
|
302
294
|
|
|
303
|
-
|
|
304
|
-
vp run test:live
|
|
305
|
-
```
|
|
295
|
+
## Contributing
|
|
306
296
|
|
|
307
|
-
|
|
297
|
+
Contributor setup, validation, and live-test workflow live in [CONTRIBUTING.md](./CONTRIBUTING.md).
|
|
308
298
|
|
|
309
|
-
|
|
310
|
-
vp run verify
|
|
311
|
-
vp run bootstrap:tokens
|
|
312
|
-
```
|
|
299
|
+
## License
|
|
313
300
|
|
|
314
|
-
|
|
315
|
-
Target-by-target live verification guidance lives in `docs/TESTING.md`.
|
|
301
|
+
This project is available under the [MIT License](./LICENSE).
|