@plurnk/plurnk-schemes-http 2.0.5 → 2.0.7

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.
Files changed (64) hide show
  1. package/README.md +10 -10
  2. package/SPEC.md +122 -606
  3. package/dist/Guard.d.ts +4 -0
  4. package/dist/Guard.d.ts.map +1 -1
  5. package/dist/Guard.js +43 -5
  6. package/dist/Guard.js.map +1 -1
  7. package/dist/Http.d.ts +1 -1
  8. package/dist/Http.d.ts.map +1 -1
  9. package/dist/Http.js +22 -619
  10. package/dist/Http.js.map +1 -1
  11. package/dist/HttpCache.d.ts +10 -0
  12. package/dist/HttpCache.d.ts.map +1 -0
  13. package/dist/HttpCache.js +384 -0
  14. package/dist/HttpCache.js.map +1 -0
  15. package/dist/HttpGet.d.ts +5 -26
  16. package/dist/HttpGet.d.ts.map +1 -1
  17. package/dist/HttpGet.js +30 -63
  18. package/dist/HttpGet.js.map +1 -1
  19. package/dist/HttpRequester.d.ts +4 -15
  20. package/dist/HttpRequester.d.ts.map +1 -1
  21. package/dist/HttpRequester.js +31 -49
  22. package/dist/HttpRequester.js.map +1 -1
  23. package/dist/HttpShared.d.ts +42 -0
  24. package/dist/HttpShared.d.ts.map +1 -0
  25. package/dist/HttpShared.js +244 -0
  26. package/dist/HttpShared.js.map +1 -0
  27. package/dist/WebFetcher.d.ts +2 -7
  28. package/dist/WebFetcher.d.ts.map +1 -1
  29. package/dist/WebFetcher.js +14 -26
  30. package/dist/WebFetcher.js.map +1 -1
  31. package/dist/Ws.d.ts.map +1 -1
  32. package/dist/Ws.js +17 -13
  33. package/dist/Ws.js.map +1 -1
  34. package/dist/index.d.ts +0 -4
  35. package/dist/index.d.ts.map +1 -1
  36. package/dist/index.js +2 -5
  37. package/dist/index.js.map +1 -1
  38. package/docs/https.md +37 -44
  39. package/docs/wss.md +27 -32
  40. package/package.json +6 -6
  41. package/dist/Config.d.ts +0 -5
  42. package/dist/Config.d.ts.map +0 -1
  43. package/dist/Config.js +0 -13
  44. package/dist/Config.js.map +0 -1
  45. package/dist/ContentType.d.ts +0 -2
  46. package/dist/ContentType.d.ts.map +0 -1
  47. package/dist/ContentType.js +0 -15
  48. package/dist/ContentType.js.map +0 -1
  49. package/dist/ErrorDetail.d.ts +0 -5
  50. package/dist/ErrorDetail.d.ts.map +0 -1
  51. package/dist/ErrorDetail.js +0 -5
  52. package/dist/ErrorDetail.js.map +0 -1
  53. package/dist/HostPolicy.d.ts +0 -11
  54. package/dist/HostPolicy.d.ts.map +0 -1
  55. package/dist/HostPolicy.js +0 -58
  56. package/dist/HostPolicy.js.map +0 -1
  57. package/dist/LiveAcquisitions.d.ts +0 -8
  58. package/dist/LiveAcquisitions.d.ts.map +0 -1
  59. package/dist/LiveAcquisitions.js +0 -30
  60. package/dist/LiveAcquisitions.js.map +0 -1
  61. package/dist/http-names.d.ts +0 -5
  62. package/dist/http-names.d.ts.map +0 -1
  63. package/dist/http-names.js +0 -6
  64. package/dist/http-names.js.map +0 -1
package/README.md CHANGED
@@ -10,13 +10,13 @@ authored against the DB-free
10
10
 
11
11
  | Operation | Behavior |
12
12
  | ---------------------------------------------- | ----------------------------------------------------------------------------------------- |
13
- | ```` ```READ (http(s)://…) ```` | Fetch or reuse/revalidate a GET representation, then project the selected response channel |
14
- | ```` ```READ (http(s)://…) <scope> ```` | Apply standard entry scope after the same acquisition/revalidation; scope does not bypass it |
15
- | ```` ```FIND (http(s)://…) [{"pattern": "…"}] ```` | Materialize an exact URL when required, then use the universal entry query and matcher |
16
- | ```` ```SEND (http(s)://…) ```` with body | POST the body and stream the response |
17
- | ```` ```EDIT (http(s)://…) ```` with body | PUT a whole-resource replacement; line-scoped HTTP edits are invalid |
18
- | ```` ```KILL (http(s)://…) ```` | Cancel a live acquisition of the address, or forget its stored response |
19
- | ```` ```KILL (http(s)://…) [{"remote": true}] ```` | DELETE the remote resource and stream the response |
13
+ | `await plurnk.read({ path: "http(s)://…" })` | Fetch or reuse/revalidate a GET representation, then project the selected response channel |
14
+ | `await plurnk.read({ path: "http(s)://…", range: "…" })` | Apply standard entry scope after the same acquisition/revalidation; scope does not bypass it |
15
+ | `await plurnk.find({ path: "http(s)://…", pattern: "…" })` | Materialize an exact URL when required, then use the universal entry query and matcher |
16
+ | `await plurnk.send({ target: "http(s)://…", text: "…" })` | POST the body and stream the response |
17
+ | `await plurnk.edit({ path: "http(s)://…", content: "…" })` | PUT a whole-resource replacement; line-scoped HTTP edits are invalid |
18
+ | `await plurnk.kill({ path: "http(s)://…" })` | Cancel a live acquisition of the address, or forget its stored response |
19
+ | `await plurnk.kill({ path: "http(s)://…", metadata: [{"remote": true}] })` | DELETE the remote resource and stream the response |
20
20
 
21
21
  A path-pattern FIND surveys already-materialized web entries; it does not crawl
22
22
  or discover the remote web. Exact matcher FIND shares the standard flat
@@ -26,7 +26,7 @@ The verbs that change a remote resource — POST, PUT, the remote DELETE, and a
26
26
  WebSocket frame (EDIT or SEND on an open `ws(s)://` socket) — propose before
27
27
  anything leaves the process, the same way a subprocess does;
28
28
  `PLURNK_SERVICE_EFFECT_HOST` decides whether that settles by consent or runs
29
- unattended ({§http-outbound-proposes}). GET and the socket open are observation
29
+ unattended ({§http-manifest}). GET and the socket open are observation
30
30
  and are ungated.
31
31
 
32
32
  ## HTTP channels
@@ -50,7 +50,7 @@ byte-readable. Input above the common binary ceiling returns `413`.
50
50
  - WebFetcher checks automatic byte targets and redirects; direct HTTP and
51
51
  WebSocket retain their explicit-target authority.
52
52
  - Generic GETs negotiate origin Markdown first. When the origin returns HTML,
53
- a selected materializer extension ({§http-materializer-extensions}) produces
53
+ a selected materializer extension ({§http-lifecycle}) produces
54
54
  `readable`; otherwise the installed HTML reader is the local route. Recoverable
55
55
  materializer failures use that same reader as a `203` recovery floor. Hard
56
56
  provider failures do not silently change producers.
@@ -80,7 +80,7 @@ Requires Node.js 26 or newer.
80
80
 
81
81
  ```sh
82
82
  npm i @plurnk/plurnk-schemes-http
83
- plurnk start
83
+ plurnk-service start
84
84
  ```
85
85
 
86
86
  The shipped `.env.defaults` is the canonical operator configuration registry.