@riebeckite/plugin-webmention 0.0.6
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/LICENSE +201 -0
- package/README.md +119 -0
- package/README_ja.md +116 -0
- package/dist/index.d.ts +53 -0
- package/dist/index.js +1159 -0
- package/dist/src/diagnostics.d.ts +6 -0
- package/dist/src/endpoints.d.ts +9 -0
- package/dist/src/feed.d.ts +28 -0
- package/dist/src/http.d.ts +5 -0
- package/dist/src/memory_provider.d.ts +14 -0
- package/dist/src/mention.d.ts +32 -0
- package/dist/src/options.d.ts +12 -0
- package/dist/src/parse.d.ts +25 -0
- package/dist/src/provider.d.ts +30 -0
- package/dist/src/query.d.ts +24 -0
- package/dist/src/receive.d.ts +20 -0
- package/dist/src/render.d.ts +12 -0
- package/dist/src/server.d.ts +24 -0
- package/dist/src/targets.d.ts +10 -0
- package/dist/src/types.d.ts +50 -0
- package/dist/src/url.d.ts +14 -0
- package/dist/src/verify.d.ts +74 -0
- package/package.json +60 -0
- package/style.css +66 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright Rerurate_514
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
# @riebeckite/plugin-webmention
|
|
2
|
+
|
|
3
|
+
Receive Webmentions, verify that the source document really links to the
|
|
4
|
+
target, store them through a pluggable provider, and render verified mentions
|
|
5
|
+
near articles. The core plugin contains **no Cloudflare, Worker, database, or
|
|
6
|
+
vendor code** and depends only on `@riebeckite/core`.
|
|
7
|
+
|
|
8
|
+
[日本語](./README_ja.md)
|
|
9
|
+
|
|
10
|
+
## Design
|
|
11
|
+
|
|
12
|
+
- `WebmentionProvider` is the storage/runtime seam: it advertises
|
|
13
|
+
`store` / `query` capabilities and exposes `store(mention)` and
|
|
14
|
+
`query(query)`. Credentials, database handles, and runtime bindings stay
|
|
15
|
+
inside the adapter and never reach plugin options or generated output.
|
|
16
|
+
- `MemoryWebmentionProvider` is included for tests, local previews, and as a
|
|
17
|
+
provider contract example. It does not persist across processes/isolates.
|
|
18
|
+
- The plugin declares `endpoints`: `POST {endpoint}` receives a Webmention and
|
|
19
|
+
`GET {endpoint}` returns the verified-mention feed. Route-framework details
|
|
20
|
+
never enter this package; the HonoX integration
|
|
21
|
+
(`mountRiebeckiteEndpoints`) mounts the contract on the host router.
|
|
22
|
+
- Verification fetches the source through an injectable
|
|
23
|
+
`WebmentionSourceFetcher`, checks for an outbound link to the target, and
|
|
24
|
+
records lightweight citation metadata (title, excerpt, author, publication
|
|
25
|
+
date, and `rel`-derived type). The default fetcher blocks loopback and
|
|
26
|
+
private-network hosts, caps the response size, and times out.
|
|
27
|
+
|
|
28
|
+
## Usage
|
|
29
|
+
|
|
30
|
+
```ts
|
|
31
|
+
import { webmention } from "@riebeckite/plugin-webmention";
|
|
32
|
+
import { d1Storage } from "@riebeckite/webmention-cloudflare";
|
|
33
|
+
|
|
34
|
+
export default {
|
|
35
|
+
plugins: [
|
|
36
|
+
webmention({ provider: d1Storage(env.WEBMENTION_DB) }),
|
|
37
|
+
],
|
|
38
|
+
};
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
Without a provider the plugin uses an in-memory provider, which is fine for
|
|
42
|
+
local previews but loses mentions between processes. Supply a durable adapter
|
|
43
|
+
(see [`@riebeckite/webmention-cloudflare`](../../integrations/webmention-cloudflare/README.md))
|
|
44
|
+
for production.
|
|
45
|
+
|
|
46
|
+
## Endpoints
|
|
47
|
+
|
|
48
|
+
| Method | Path | Behavior |
|
|
49
|
+
| ------ | -------------------------- | -------- |
|
|
50
|
+
| `POST` | `/webmentions` (default) | Accepts `application/x-www-form-urlencoded` or `application/json` with `source` and `target`. Returns `202` when accepted, `400` with an `error` code when rejected, or `503` when storage is unavailable. |
|
|
51
|
+
| `GET` | `/webmentions` (default) | Returns the verified-mention feed as JSON: `{ version, generatedAt, count, mentions }`. Supports `?target=`, `?limit=`, and `?since=`. Returns `501` when the provider cannot query. |
|
|
52
|
+
|
|
53
|
+
Rejection codes: `invalid_request`, `missing_source_or_target`,
|
|
54
|
+
`target_not_found`, `invalid_source`, `invalid_target`, `source_unreachable`,
|
|
55
|
+
`no_link_found`.
|
|
56
|
+
|
|
57
|
+
## Rendering
|
|
58
|
+
|
|
59
|
+
At `onManifestCreated` the plugin queries the provider once, groups verified
|
|
60
|
+
mentions by target, and appends a section to each matching entry's HTML (and to
|
|
61
|
+
the cached `PostContent`) using stable hooks:
|
|
62
|
+
|
|
63
|
+
```html
|
|
64
|
+
<section class="rr-webmention" data-webmention data-webmention-count="2">
|
|
65
|
+
<h2 class="rr-webmention__heading">Mentions</h2>
|
|
66
|
+
<ul class="rr-webmention__list">
|
|
67
|
+
<li class="rr-webmention__item rr-webmention__item--like"
|
|
68
|
+
data-webmention-type="like">…</li>
|
|
69
|
+
</ul>
|
|
70
|
+
</section>
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Set `render: false` to skip build-time injection. Applications that render at
|
|
74
|
+
request time can call `getWebmentionsForEntry({ manifest, config, provider,
|
|
75
|
+
slug })` and `renderWebmentionSection(mentions, options)` directly, or consume
|
|
76
|
+
the JSON feed.
|
|
77
|
+
|
|
78
|
+
## Options
|
|
79
|
+
|
|
80
|
+
| Option | Default | Description |
|
|
81
|
+
| ------ | ------- | ----------- |
|
|
82
|
+
| `provider` | in-memory | Storage adapter implementing `WebmentionProvider`. |
|
|
83
|
+
| `endpoint` | `"/webmentions"` | Receive (POST) and feed (GET) path. |
|
|
84
|
+
| `render` | `true` | Append stored mentions to matching entries at manifest time. |
|
|
85
|
+
| `headingText` | `"Mentions"` | Heading for the rendered section. |
|
|
86
|
+
| `limit` | `20` | Maximum mentions rendered per article. |
|
|
87
|
+
| `className` | `"rr-webmention"` | Root CSS class of the rendered section. |
|
|
88
|
+
| `allowedTargets` | `[]` | Extra absolute target URLs accepted beyond published entries. |
|
|
89
|
+
| `fetchSource` | global `fetch` | Source fetcher override (tests, custom runtimes). |
|
|
90
|
+
| `timeoutMs` | `10000` | Source fetch timeout. |
|
|
91
|
+
| `maxBytes` | `1000000` | Maximum accepted source document size. |
|
|
92
|
+
| `userAgent` | plugin default | `User-Agent` used when verifying. |
|
|
93
|
+
| `allowPrivateHosts` | `false` | Allow fetching private-network sources. |
|
|
94
|
+
| `nofollow` | `true` | Add `rel="nofollow ugc"` to rendered source links. |
|
|
95
|
+
|
|
96
|
+
Only JSON-safe values ever reach the browser. The plugin registers no client
|
|
97
|
+
entry and no `publicConfig`, and provider credentials never enter options.
|
|
98
|
+
|
|
99
|
+
## Diagnostics
|
|
100
|
+
|
|
101
|
+
`addDiagnostics` reports provider capability gaps
|
|
102
|
+
(`webmention-render-requires-query`, `webmention-receive-requires-store`). At
|
|
103
|
+
manifest time, mentions whose target is not a published entry are reported as
|
|
104
|
+
`webmention-unmatched-target`.
|
|
105
|
+
|
|
106
|
+
## Exports
|
|
107
|
+
|
|
108
|
+
- `webmention()` / `webmentionPlugin()`
|
|
109
|
+
- `MemoryWebmentionProvider`, provider/capability types and errors
|
|
110
|
+
- `parseWebmentionSource`, `findTargetLink`, `verifyWebmention`,
|
|
111
|
+
`createWebmentionSourceFetcher`
|
|
112
|
+
- `renderWebmentionSection`, `getWebmentionsForEntry`,
|
|
113
|
+
`groupMentionsBySlug`, `buildFeed`
|
|
114
|
+
- `resolveWebmentionOptions`, `validateWebmentionOptions`
|
|
115
|
+
|
|
116
|
+
## See also
|
|
117
|
+
|
|
118
|
+
- [Plugin guide](../../../docs/en/plugin-system.md)
|
|
119
|
+
- [@riebeckite/webmention-cloudflare](../../integrations/webmention-cloudflare/README.md)
|
package/README_ja.md
ADDED
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# @riebeckite/plugin-webmention
|
|
2
|
+
|
|
3
|
+
Webmention を受信し、送信元ドキュメントが本当にターゲットへリンクしているかを検証し、
|
|
4
|
+
プラガブルな provider 経由で保存して、検証済みのメンションを記事の近くに表示します。
|
|
5
|
+
コアプラグインには **Cloudflare・Worker・データベース・ベンダー固有のコードは一切なく**、
|
|
6
|
+
依存は `@riebeckite/core` だけです。
|
|
7
|
+
|
|
8
|
+
[English](./README.md)
|
|
9
|
+
|
|
10
|
+
## 設計
|
|
11
|
+
|
|
12
|
+
- `WebmentionProvider` が storage / runtime の境界です。`store` / `query` の
|
|
13
|
+
capability を公開し、`store(mention)` と `query(query)` を持ちます。認証情報・
|
|
14
|
+
データベースハンドル・実行時バインディングは adapter 内に留まり、プラグインの
|
|
15
|
+
options や生成物へ漏れません。
|
|
16
|
+
- `MemoryWebmentionProvider` はテスト・ローカルプレビュー・provider 契約の例として
|
|
17
|
+
同梱されています。プロセス/isolate をまたいで永続化はしません。
|
|
18
|
+
- プラグインは `endpoints` を宣言します。`POST {endpoint}` が Webmention を受信し、
|
|
19
|
+
`GET {endpoint}` が検証済みメンションのフィードを返します。ルートフレームワークの
|
|
20
|
+
詳細はこのパッケージへ入りません。HonoX 連携(`mountRiebeckiteEndpoints`)が
|
|
21
|
+
契約をホストルーターへマウントします。
|
|
22
|
+
- 検証は注入可能な `WebmentionSourceFetcher` を通じて送信元を取得し、ターゲットへの
|
|
23
|
+
発リンクを確認したうえで、軽量な引用メタデータ(title・excerpt・author・公開日・
|
|
24
|
+
`rel` 由来の種別)を記録します。既定の fetcher は loopback とプライベートネット
|
|
25
|
+
ワーク宛てを拒否し、本文サイズを制限し、タイムアウトします。
|
|
26
|
+
|
|
27
|
+
## 使い方
|
|
28
|
+
|
|
29
|
+
```ts
|
|
30
|
+
import { webmention } from "@riebeckite/plugin-webmention";
|
|
31
|
+
import { d1Storage } from "@riebeckite/webmention-cloudflare";
|
|
32
|
+
|
|
33
|
+
export default {
|
|
34
|
+
plugins: [
|
|
35
|
+
webmention({ provider: d1Storage(env.WEBMENTION_DB) }),
|
|
36
|
+
],
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
provider を省略するとインメモリ provider が使われます。ローカルプレビューには
|
|
41
|
+
十分ですが、プロセスをまたぐとメンションは失われます。本番では永続 adapter
|
|
42
|
+
([`@riebeckite/webmention-cloudflare`](../../integrations/webmention-cloudflare/README_ja.md) を参照)
|
|
43
|
+
を指定してください。
|
|
44
|
+
|
|
45
|
+
## エンドポイント
|
|
46
|
+
|
|
47
|
+
| Method | Path | 動作 |
|
|
48
|
+
| ------ | -------------------------- | ---- |
|
|
49
|
+
| `POST` | `/webmentions`(既定) | `source` と `target` を含む `application/x-www-form-urlencoded` または `application/json` を受け付けます。受理時は `202`、拒否時は `error` コード付きの `400`、ストレージ不能時は `503` を返します。 |
|
|
50
|
+
| `GET` | `/webmentions`(既定) | 検証済みメンションのフィードを JSON(`{ version, generatedAt, count, mentions }`)で返します。`?target=`・`?limit=`・`?since=` に対応。query 不能な provider では `501` を返します。 |
|
|
51
|
+
|
|
52
|
+
拒否コード: `invalid_request`、`missing_source_or_target`、`target_not_found`、
|
|
53
|
+
`invalid_source`、`invalid_target`、`source_unreachable`、`no_link_found`。
|
|
54
|
+
|
|
55
|
+
## 表示
|
|
56
|
+
|
|
57
|
+
`onManifestCreated` で provider を一度 query し、検証済みメンションをターゲット別に
|
|
58
|
+
グループ化して、対応する entry の HTML(およびキャッシュされた `PostContent`)へ
|
|
59
|
+
セクションを追記します。フックは安定した `rr-webmention` 名です。
|
|
60
|
+
|
|
61
|
+
```html
|
|
62
|
+
<section class="rr-webmention" data-webmention data-webmention-count="2">
|
|
63
|
+
<h2 class="rr-webmention__heading">Mentions</h2>
|
|
64
|
+
<ul class="rr-webmention__list">
|
|
65
|
+
<li class="rr-webmention__item rr-webmention__item--like"
|
|
66
|
+
data-webmention-type="like">…</li>
|
|
67
|
+
</ul>
|
|
68
|
+
</section>
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
`render: false` でビルド時の追記を無効化できます。リクエスト時に描画する
|
|
72
|
+
アプリケーションは `getWebmentionsForEntry({ manifest, config, provider, slug })` と
|
|
73
|
+
`renderWebmentionSection(mentions, options)` を直接呼ぶか、JSON フィードを利用します。
|
|
74
|
+
|
|
75
|
+
## オプション
|
|
76
|
+
|
|
77
|
+
| オプション | 既定値 | 説明 |
|
|
78
|
+
| ---------- | ------ | ---- |
|
|
79
|
+
| `provider` | インメモリ | `WebmentionProvider` を実装するストレージ adapter。 |
|
|
80
|
+
| `endpoint` | `"/webmentions"` | 受信(POST)とフィード(GET)のパス。 |
|
|
81
|
+
| `render` | `true` | manifest 生成時に対応 entry へメンションを追記します。 |
|
|
82
|
+
| `headingText` | `"Mentions"` | 表示セクションの見出し。 |
|
|
83
|
+
| `limit` | `20` | 記事ごとに表示する最大メンション数。 |
|
|
84
|
+
| `className` | `"rr-webmention"` | 表示セクションのルート CSS クラス。 |
|
|
85
|
+
| `allowedTargets` | `[]` | 公開 entry 以外で受理する絶対ターゲット URL。 |
|
|
86
|
+
| `fetchSource` | グローバル `fetch` | 送信元 fetcher の差し替え(テスト・独自 runtime)。 |
|
|
87
|
+
| `timeoutMs` | `10000` | 送信元取得のタイムアウト。 |
|
|
88
|
+
| `maxBytes` | `1000000` | 受理する送信元ドキュメントの最大サイズ。 |
|
|
89
|
+
| `userAgent` | プラグイン既定 | 検証時の `User-Agent`。 |
|
|
90
|
+
| `allowPrivateHosts` | `false` | プライベートネットワーク宛ての取得を許可します。 |
|
|
91
|
+
| `nofollow` | `true` | 表示する送信元リンクへ `rel="nofollow ugc"` を付与します。 |
|
|
92
|
+
|
|
93
|
+
ブラウザへ渡るのは JSON 安全な値だけです。このプラグインは client entry も
|
|
94
|
+
`publicConfig` も登録せず、provider の認証情報は options に入りません。
|
|
95
|
+
|
|
96
|
+
## 診断
|
|
97
|
+
|
|
98
|
+
`addDiagnostics` は provider の capability 不足
|
|
99
|
+
(`webmention-render-requires-query`、`webmention-receive-requires-store`)を報告します。
|
|
100
|
+
manifest 生成時、公開 entry に一致しないターゲットのメンションは
|
|
101
|
+
`webmention-unmatched-target` として報告されます。
|
|
102
|
+
|
|
103
|
+
## エクスポート
|
|
104
|
+
|
|
105
|
+
- `webmention()` / `webmentionPlugin()`
|
|
106
|
+
- `MemoryWebmentionProvider`、provider / capability の型とエラー
|
|
107
|
+
- `parseWebmentionSource`、`findTargetLink`、`verifyWebmention`、
|
|
108
|
+
`createWebmentionSourceFetcher`
|
|
109
|
+
- `renderWebmentionSection`、`getWebmentionsForEntry`、`groupMentionsBySlug`、
|
|
110
|
+
`buildFeed`
|
|
111
|
+
- `resolveWebmentionOptions`、`validateWebmentionOptions`
|
|
112
|
+
|
|
113
|
+
## 関連
|
|
114
|
+
|
|
115
|
+
- [プラグインガイド](../../../docs/ja/plugin-system.md)
|
|
116
|
+
- [@riebeckite/webmention-cloudflare](../../integrations/webmention-cloudflare/README_ja.md)
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
import { buildWebmentionDiagnostics } from "./src/diagnostics.js";
|
|
2
|
+
import type { WebmentionOptions } from "./src/types.js";
|
|
3
|
+
export { createWebmentionEndpoints } from "./src/endpoints.js";
|
|
4
|
+
export type { WebmentionFeed, WebmentionFeedEntry, WebmentionFeedMention, } from "./src/feed.js";
|
|
5
|
+
export { buildFeed, createWebmentionFeedHandler, summarizeEntry, } from "./src/feed.js";
|
|
6
|
+
export { MemoryWebmentionProvider } from "./src/memory_provider.js";
|
|
7
|
+
export type { WebmentionAuthor, WebmentionMention, WebmentionType, } from "./src/mention.js";
|
|
8
|
+
export { WEBMENTION_TYPES, webmentionKey } from "./src/mention.js";
|
|
9
|
+
export { DEFAULT_WEBMENTION_CLASS_NAME, DEFAULT_WEBMENTION_ENDPOINT, DEFAULT_WEBMENTION_HEADING_TEXT, DEFAULT_WEBMENTION_LIMIT, resolveWebmentionOptions, validateWebmentionOptions, } from "./src/options.js";
|
|
10
|
+
export type { ParsedWebmentionLink, ParsedWebmentionSource, } from "./src/parse.js";
|
|
11
|
+
export { findTargetLink, parseWebmentionSource, webmentionTypeForRels, } from "./src/parse.js";
|
|
12
|
+
export type { WebmentionCapability, WebmentionProvider, } from "./src/provider.js";
|
|
13
|
+
export { assertWebmentionQuerySupported, requiredCapabilityForQuery, supportsWebmentionCapability, UnsupportedWebmentionQueryError, WEBMENTION_CAPABILITIES, } from "./src/provider.js";
|
|
14
|
+
export type { AllMentionsQuery, AllMentionsResult, MentionsForTargetQuery, MentionsForTargetResult, WebmentionQuery, WebmentionQueryResult, } from "./src/query.js";
|
|
15
|
+
export { createWebmentionReceiveHandler, parseWebmentionRequestBody, } from "./src/receive.js";
|
|
16
|
+
export { renderWebmentionItem, renderWebmentionSection, WEBMENTION_ATTRIBUTE, } from "./src/render.js";
|
|
17
|
+
export { compareMentions, countUnmatchedMentions, getWebmentionsForEntry, groupMentionsBySlug, } from "./src/server.js";
|
|
18
|
+
export { entryPublicUrl, findTargetEntry, isAllowedTarget, } from "./src/targets.js";
|
|
19
|
+
export type { ResolvedWebmentionOptions, WebmentionOptions, } from "./src/types.js";
|
|
20
|
+
export { normalizeWebmentionUrl, resolvePublicUrl, urlComparisonKey, } from "./src/url.js";
|
|
21
|
+
export type { WebmentionRejectionReason, WebmentionSourceDocument, WebmentionSourceFetcher, WebmentionSourceFetcherOptions, WebmentionVerification, } from "./src/verify.js";
|
|
22
|
+
export { createWebmentionSourceFetcher, DEFAULT_WEBMENTION_MAX_BYTES, DEFAULT_WEBMENTION_TIMEOUT_MS, DEFAULT_WEBMENTION_USER_AGENT, verifyWebmention, } from "./src/verify.js";
|
|
23
|
+
export type { WebmentionOptions as WebmentionPluginOptions };
|
|
24
|
+
/** Alias matching the `*Plugin` suffix used by other plugin factories. */
|
|
25
|
+
export declare const webmentionPlugin: typeof webmention;
|
|
26
|
+
/**
|
|
27
|
+
* Receives Webmentions and displays verified ones as "mentions" near articles.
|
|
28
|
+
*
|
|
29
|
+
* The plugin is storage- and vendor-agnostic: it defines the
|
|
30
|
+
* `WebmentionProvider` seam and ships an in-memory provider for local use. A
|
|
31
|
+
* runtime adapter (for example `@riebeckite/webmention-cloudflare`) supplies
|
|
32
|
+
* durable storage.
|
|
33
|
+
*
|
|
34
|
+
* It declares `endpoints` for `POST` (receive) and `GET` (feed) on the
|
|
35
|
+
* configured path; the HonoX integration mounts them on the host router. No
|
|
36
|
+
* framework or application code is imported here.
|
|
37
|
+
*/
|
|
38
|
+
export declare function webmention(options?: WebmentionOptions): import("@riebeckite/core").RiebeckitePlugin<Readonly<{
|
|
39
|
+
provider?: import("./index.js").WebmentionProvider;
|
|
40
|
+
endpoint?: string;
|
|
41
|
+
render?: boolean;
|
|
42
|
+
headingText?: string;
|
|
43
|
+
limit?: number;
|
|
44
|
+
className?: string;
|
|
45
|
+
allowedTargets?: readonly string[];
|
|
46
|
+
fetchSource?: import("./index.js").WebmentionSourceFetcher;
|
|
47
|
+
timeoutMs?: number;
|
|
48
|
+
maxBytes?: number;
|
|
49
|
+
userAgent?: string;
|
|
50
|
+
allowPrivateHosts?: boolean;
|
|
51
|
+
nofollow?: boolean;
|
|
52
|
+
}>>;
|
|
53
|
+
export { buildWebmentionDiagnostics };
|