@raintree-technology/docpull-sdk 6.5.0 → 6.5.5
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 +18 -2
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# @raintree-technology/docpull-sdk
|
|
2
2
|
|
|
3
|
-
TypeScript SDK for
|
|
3
|
+
**Active TypeScript SDK for Node and Bun developers consuming DocPull packs.**
|
|
4
|
+
|
|
5
|
+
TypeScript SDK for [DocPull](https://github.com/raintree-technology/docpull).
|
|
4
6
|
It reads local context packs (the v3 pack contract) and runs the `docpull`
|
|
5
7
|
CLI from Node or Bun. Reading a pack never touches the network; fetching
|
|
6
8
|
requires the `docpull` CLI on PATH.
|
|
@@ -29,6 +31,9 @@ const pack = await readPack("./packs/example");
|
|
|
29
31
|
console.log(pack.documents.length);
|
|
30
32
|
```
|
|
31
33
|
|
|
34
|
+
Expected result: the SDK returns the manifest and document records from the
|
|
35
|
+
local pack without making a network request.
|
|
36
|
+
|
|
32
37
|
`readDocuments` prefers `documents.ndjson` and falls back to
|
|
33
38
|
`documents.jsonl`. Types (`CorpusManifest`, `ManifestRecord`,
|
|
34
39
|
`DocumentRecord`) mirror the field names written by the Python side and keep
|
|
@@ -50,7 +55,18 @@ console.log(result.stdout);
|
|
|
50
55
|
Commands are spawned with an argument array and `shell: false`. A non-zero
|
|
51
56
|
exit rejects with a `DocpullCliError` that carries `exitCode` and `stderr`.
|
|
52
57
|
|
|
53
|
-
##
|
|
58
|
+
## Compatibility and boundaries
|
|
59
|
+
|
|
60
|
+
- Runs on Node 20+ and Bun.
|
|
61
|
+
- Reads the v3 pack contract and preserves unknown fields as metadata.
|
|
62
|
+
- Pack reads are local. `fetchToPack` requires a compatible `docpull` CLI on
|
|
63
|
+
`PATH` and can make the network requests requested by that command.
|
|
64
|
+
- The SDK does not validate the truth or completeness of source content.
|
|
65
|
+
|
|
66
|
+
See the [DocPull README](../../README.md) and [security
|
|
67
|
+
policy](../../SECURITY.md) for the broader boundary.
|
|
68
|
+
|
|
69
|
+
## Maintainer checks
|
|
54
70
|
|
|
55
71
|
```bash
|
|
56
72
|
bun install # from the repo root
|