@seedprotocol/feed-hyper 0.7.4 → 0.7.5-next.871.g8788c94
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 +15 -6
- package/package.json +19 -4
package/README.md
CHANGED
|
@@ -1,10 +1,12 @@
|
|
|
1
1
|
# @seedprotocol/feed-hyper
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@seedprotocol/feed-hyper)
|
|
4
|
+
|
|
3
5
|
Publish Seed Protocol RSS/Atom/JSON feeds into a **Hyperdrive**, announce them on **Hyperswarm**, and serve them to ordinary RSS readers over localhost HTTP.
|
|
4
6
|
|
|
5
7
|
`seed-feed serve` accepts both drive paths (`/posts/rss.xml`) and historical HTTP paths (`/posts/rss`).
|
|
6
8
|
|
|
7
|
-
Generation stays in [`@seedprotocol/feed`](
|
|
9
|
+
Generation stays in [`@seedprotocol/feed`](https://github.com/JournoLabs/seed-protocol-sdk/blob/main/packages/feed/README.md). This package is transport only (Node 20+). It pulls in Holepunch native modules (`sodium-native`, etc.). Part of [Seed Protocol](https://seedprotocol.io); see also [`@seedprotocol/sdk`](https://www.npmjs.com/package/@seedprotocol/sdk).
|
|
8
10
|
|
|
9
11
|
## Trust model
|
|
10
12
|
|
|
@@ -25,13 +27,13 @@ Generation stays in [`@seedprotocol/feed`](../feed). This package is transport o
|
|
|
25
27
|
|
|
26
28
|
`registry.json` lists schemas, formats, the drive key, and last update metadata.
|
|
27
29
|
|
|
28
|
-
##
|
|
30
|
+
## Installation
|
|
29
31
|
|
|
30
32
|
```bash
|
|
31
|
-
|
|
33
|
+
npm install @seedprotocol/feed-hyper
|
|
32
34
|
```
|
|
33
35
|
|
|
34
|
-
Requires a toolchain that can build Holepunch native addons.
|
|
36
|
+
Requires Node 20+ and a toolchain that can build Holepunch native addons. Installs the `seed-feed` CLI.
|
|
35
37
|
|
|
36
38
|
## Library API
|
|
37
39
|
|
|
@@ -76,6 +78,7 @@ Pass `fixtureContents: { '/posts/rss.xml': '...' }` to `publishFeed` to skip EAS
|
|
|
76
78
|
|
|
77
79
|
```bash
|
|
78
80
|
seed-feed publish --schema post --format rss,atom,json --store .seed/feed-store
|
|
81
|
+
# optional: --drive-name <name> --page-size <n> --site-url <url>
|
|
79
82
|
seed-feed seed <key> --store .seed/feed-store
|
|
80
83
|
seed-feed serve <key> --port 8080 --host 127.0.0.1
|
|
81
84
|
```
|
|
@@ -89,12 +92,14 @@ Use `--no-announce` on publish/serve to stay offline (local store only).
|
|
|
89
92
|
3. Point RSS apps at `http://127.0.0.1:8080/posts/rss.xml` or `http://127.0.0.1:8080/posts/rss` after `seed-feed serve`.
|
|
90
93
|
4. Unpublish/revocation: regenerating omits revoked items from the **current** drive version; Hypercore history retains prior versions.
|
|
91
94
|
|
|
92
|
-
See [docs/FEED_HYPER.md](
|
|
95
|
+
See [docs/FEED_HYPER.md](https://github.com/JournoLabs/seed-protocol-sdk/blob/main/docs/FEED_HYPER.md) for the full runbook and manual validation checklist.
|
|
93
96
|
|
|
94
97
|
## Tests
|
|
95
98
|
|
|
96
99
|
Path tests always run. Native Corestore/Hyperdrive/HTTP tests run when `FEED_HYPER_TESTS=1` or when not in CI (`FEED_HYPER_TESTS=0` to skip).
|
|
97
100
|
|
|
101
|
+
From a checkout of the monorepo:
|
|
102
|
+
|
|
98
103
|
```bash
|
|
99
104
|
cd packages/feed-hyper && bunx vitest run
|
|
100
105
|
FEED_HYPER_TESTS=1 bunx vitest run
|
|
@@ -104,4 +109,8 @@ FEED_HYPER_TESTS=1 bunx vitest run
|
|
|
104
109
|
|
|
105
110
|
## Manual validation checklist
|
|
106
111
|
|
|
107
|
-
See [docs/FEED_HYPER.md](
|
|
112
|
+
See [docs/FEED_HYPER.md](https://github.com/JournoLabs/seed-protocol-sdk/blob/main/docs/FEED_HYPER.md).
|
|
113
|
+
|
|
114
|
+
## License
|
|
115
|
+
|
|
116
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,9 +1,20 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seedprotocol/feed-hyper",
|
|
3
|
-
"version": "0.7.
|
|
4
|
-
"description": "Hyperdrive
|
|
3
|
+
"version": "0.7.5-next.871.g8788c94",
|
|
4
|
+
"description": "Publish, seed and serve Seed Protocol feeds over Hyperdrive and Hyperswarm, with a localhost HTTP gateway and the seed-feed CLI",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"seed-protocol",
|
|
7
|
+
"rss",
|
|
8
|
+
"feed",
|
|
9
|
+
"hyperdrive",
|
|
10
|
+
"hyperswarm",
|
|
11
|
+
"holepunch",
|
|
12
|
+
"p2p",
|
|
13
|
+
"cli"
|
|
14
|
+
],
|
|
5
15
|
"type": "module",
|
|
6
16
|
"main": "./dist/index.js",
|
|
17
|
+
"types": "./dist/index.d.ts",
|
|
7
18
|
"bin": {
|
|
8
19
|
"seed-feed": "./dist/bin.js"
|
|
9
20
|
},
|
|
@@ -32,8 +43,8 @@
|
|
|
32
43
|
"prepublishOnly": "bun run build && node ../../scripts/sync-versions.js"
|
|
33
44
|
},
|
|
34
45
|
"dependencies": {
|
|
35
|
-
"@seedprotocol/arweave": "0.7.
|
|
36
|
-
"@seedprotocol/feed": "0.7.
|
|
46
|
+
"@seedprotocol/arweave": "0.7.5-next.871.g8788c94",
|
|
47
|
+
"@seedprotocol/feed": "0.7.5-next.871.g8788c94",
|
|
37
48
|
"corestore": "^7.12.0",
|
|
38
49
|
"hypercore-id-encoding": "^1.3.0",
|
|
39
50
|
"hyperdrive": "^13.0.0",
|
|
@@ -56,6 +67,10 @@
|
|
|
56
67
|
"url": "git+https://github.com/JournoLabs/seed-protocol-sdk.git",
|
|
57
68
|
"directory": "packages/feed-hyper"
|
|
58
69
|
},
|
|
70
|
+
"homepage": "https://github.com/JournoLabs/seed-protocol-sdk/tree/main/packages/feed-hyper#readme",
|
|
71
|
+
"bugs": {
|
|
72
|
+
"url": "https://github.com/JournoLabs/seed-protocol-sdk/issues"
|
|
73
|
+
},
|
|
59
74
|
"publishConfig": {
|
|
60
75
|
"access": "public"
|
|
61
76
|
}
|