@riebeckite/plugin-webmention 0.0.31 → 0.0.33

package/README.md

@@ -108,7 +108,7 @@ manifest time, mentions whose target is not a published entry are reported as
 
 ## Exports
 
-- `webmention()` / `webmentionPlugin()`
+- `webmention()` / `webmention()`
 - `MemoryWebmentionProvider`, provider/capability types and errors
 - `parseWebmentionSource`, `findTargetLink`, `verifyWebmention`,
   `createWebmentionSourceFetcher`

package/README_ja.md

@@ -2,29 +2,16 @@
 
 <!-- Generated from docs/docs/plugins/webmention.ja.md. Edit the canonical documentation in docs/docs/plugins and run `pnpm docs:sync`. -->
 
-Webmention を受信し、送信元ドキュメントが本当にターゲットへリンクしているかを検証し、
-プラガブルな provider 経由で保存して、検証済みのメンションを記事の近くに表示します。
-コアプラグインには **Cloudflare・Worker・データベース・ベンダー固有のコードは一切なく**、
-依存は `@riebeckite/core` だけです。
+Webmention を受信し、送信元ドキュメントが本当にターゲットへリンクしているかを検証し、差し替え可能なプロバイダー経由で保存して、検証済みのメンションを記事の近くに表示します。コアプラグインには **Cloudflare・Worker・データベース・ベンダー固有のコードは一切なく**、依存は `@riebeckite/core` だけです。
 
 [English](./README.md)
 
 ## 設計
 
-- `WebmentionProvider` が storage / runtime の境界です。`store` / `query` の
-  capability を公開し、`store(mention)` と `query(query)` を持ちます。認証情報・
-  データベースハンドル・実行時バインディングは adapter 内に留まり、プラグインの
-  options や生成物へ漏れません。
-- `MemoryWebmentionProvider` はテスト・ローカルプレビューで使う provider の例として
-  同梱されています。プロセス／isolate をまたいで永続化はしません。
-- プラグインは `endpoints` を宣言します。`POST {endpoint}` が Webmention を受信し、
-  `GET {endpoint}` が検証済みメンションのフィードを返します。ルートフレームワークの
-  詳細はこのパッケージへ入りません。HonoX 連携（`mountRiebeckiteEndpoints`）が
-  エンドポイントをホストルーターへマウントします。
-- 検証は注入可能な `WebmentionSourceFetcher` を通じて送信元を取得し、ターゲットへの
-  発リンクを確認したうえで、軽量な引用メタデータ（title・excerpt・author・公開日・
-  `rel` 由来の種別）を記録します。既定の fetcher は loopback とプライベートネット
-  ワーク宛てを拒否し、本文サイズを制限し、タイムアウトします。
+- `WebmentionProvider` がストレージとランタイムの境界です。`store` / `query` のケイパビリティを公開し、`store(mention)` と `query(query)` を持ちます。認証情報・データベースハンドル・実行時バインディングはアダプター内に留まり、プラグインの options や生成物へ漏れません。
+- `MemoryWebmentionProvider` はテスト・ローカルプレビュー・プロバイダーの実装例として同梱されています。プロセスや isolate をまたいで永続化はしません。
+- プラグインは `endpoints` を宣言します。`POST {endpoint}` が Webmention を受信し、`GET {endpoint}` が検証済みメンションのフィードを返します。ルートフレームワークの詳細はこのパッケージへ入りません。HonoX 連携（`mountRiebeckiteEndpoints`）がエンドポイントをホストルーターへマウントします。
+- 検証は注入可能な `WebmentionSourceFetcher` を通じて送信元を取得し、ターゲットへの発リンクを確認したうえで、軽量な引用メタデータ（title・excerpt・author・公開日・`rel` 由来の種別）を記録します。既定のフェッチャーはループバックとプライベートネットワーク宛てを拒否し、本文サイズを制限し、タイムアウトします。
 
 ## 使い方
 
@@ -39,27 +26,21 @@ export default {
 };
 ```
 
-provider を省略するとインメモリ provider が使われます。ローカルプレビューには
-十分ですが、プロセスをまたぐとメンションは失われます。本産では永続 adapter
-（[`@riebeckite/webmention-cloudflare`](https://github.com/Rerurate514/riebeckite/blob/main/packages/integrations/webmention-cloudflare/README_ja.md) を参照）
-を指定してください。
+プロバイダーを省略するとインメモリのプロバイダーが使われます。ローカルプレビューには十分ですが、プロセスをまたぐとメンションは失われます。本番では永続アダプター（[`@riebeckite/webmention-cloudflare`](https://github.com/Rerurate514/riebeckite/blob/main/packages/integrations/webmention-cloudflare/README_ja.md) を参照）を指定してください。
 
 ## エンドポイント
 
-| Method | Path                       | 動作 |
+| メソッド | パス                       | 動作 |
 | ------ | -------------------------- | ---- |
 | `POST` | `/webmentions`（既定）      | `source` と `target` を含む `application/x-www-form-urlencoded` または `application/json` を受け付けます。受理時は `202`、拒否時は `error` コード付きの `400`、ストレージ不能時は `503` を返します。 |
-| `GET`  | `/webmentions`（既定）      | 検証済みメンションのフィードを JSON（`{ version, generatedAt, count, mentions }`）で返します。`?target=`・`?limit=`・`?since=` に対応。query 不能な provider では `501` を返します。 |
+| `GET`  | `/webmentions`（既定）      | 検証済みメンションのフィードを JSON（`{ version, generatedAt, count, mentions }`）で返します。`?target=`・`?limit=`・`?since=` に対応。query に対応しないプロバイダーでは `501` を返します。 |
 
 拒否コード: `invalid_request`、`missing_source_or_target`、`target_not_found`、
 `invalid_source`、`invalid_target`、`source_unreachable`、`no_link_found`。
 
-## 表示
+## 記事近くのメンション表示
 
-Site が JSX の配置を所有します。Provider のインスタンスは Site の composition で保持し、
-同じインスタンスを `webmention()` へ渡してから、`getWebmentionSectionData` で
-コンポーネントの型付き props を取得します。helper は `PublicContentView` を受け取るため、
-draft と scheduled の entry は描画できません。
+サイトが JSX の配置を所有します。プロバイダーのインスタンスはサイトの構成で保持し、同じインスタンスを `webmention()` へ渡してから、`getWebmentionSectionData` でコンポーネントの型付き props を取得します。ヘルパーは `PublicContentView` を受け取るため、draft と scheduled のエントリは描画できません。
 
 ```tsx
 const mentions = await getWebmentionSectionData({
@@ -72,42 +53,35 @@ const mentions = await getWebmentionSectionData({
 <WebmentionSection {...mentions} />
 ```
 
-空の Provider は空の model を返し、`WebmentionSection` は何も描画しません。Plugin は
-ビルド時に manifest HTML を注入しません。より低レベルな query が必要な場合は、
-`getWebmentionsForEntry({ manifest, config, provider, slug })` を直接呼ぶか、JSON フィードを
-利用できます。
+空のプロバイダーは空のモデルを返し、`WebmentionSection` は何も描画しません。プラグインはビルド時にマニフェストの HTML を注入しません。より低レベルな query が必要な場合は、`getWebmentionsForEntry({ manifest, config, provider, slug })` を直接呼ぶか、JSON フィードを利用できます。
 
 ## オプション
 
 | オプション | 既定値 | 説明 |
 | ---------- | ------ | ---- |
-| `provider` | インメモリ | `WebmentionProvider` を実装するストレージ adapter。 |
+| `provider` | インメモリ | `WebmentionProvider` を実装するストレージアダプター。 |
 | `endpoint` | `"/webmentions"` | 受信（POST）とフィード（GET）のパス。 |
 | `headingText` | `"Mentions"` | 表示セクションの見出し。 |
 | `limit` | `20` | 記事ごとに表示する最大メンション数。 |
 | `className` | `"rr-webmention"` | 表示セクションのルート CSS クラス。 |
-| `allowedTargets` | `[]` | 公開 entry 以外で受理する絶対ターゲット URL。 |
-| `fetchSource` | グローバル `fetch` | 送信元 fetcher の差し替え（テスト・独自 runtime）。 |
+| `allowedTargets` | `[]` | 公開エントリ以外で受理する絶対ターゲット URL。 |
+| `fetchSource` | グローバル `fetch` | 送信元フェッチャーの差し替え（テスト・独自ランタイム）。 |
 | `timeoutMs` | `10000` | 送信元取得のタイムアウト。 |
 | `maxBytes` | `1000000` | 受理する送信元ドキュメントの最大サイズ。 |
 | `userAgent` | プラグイン既定 | 検証時の `User-Agent`。 |
 | `allowPrivateHosts` | `false` | プライベートネットワーク宛ての取得を許可します。 |
 | `nofollow` | `true` | 表示する送信元リンクへ `rel="nofollow ugc"` を付与します。 |
 
-ブラウザへ渡るのは JSON 安全な値だけです。このプラグインは client entry も
-`publicConfig` も登録せず、provider の認証情報は options に入りません。
+ブラウザへ渡るのは JSON 安全な値だけです。このプラグインはクライアントエントリも `publicConfig` も登録せず、プロバイダーの認証情報は options に入りません。
 
 ## 診断
 
-`addDiagnostics` は provider の capability 不足
-（`webmention-render-requires-query`、`webmention-receive-requires-store`）を報告します。
-manifest 生成時、公開 entry に一致しないターゲットのメンションは
-`webmention-unmatched-target` として報告されます。
+`addDiagnostics` はプロバイダーのケイパビリティ不足（`webmention-render-requires-query`、`webmention-receive-requires-store`）を報告します。マニフェスト生成時、公開エントリに一致しないターゲットのメンションは `webmention-unmatched-target` として報告されます。
 
 ## エクスポート
 
-- `webmention()` / `webmentionPlugin()`
-- `MemoryWebmentionProvider`、provider / capability の型とエラー
+- `webmention()` / `webmention()`
+- `MemoryWebmentionProvider`、プロバイダーとケイパビリティの型およびエラー
 - `parseWebmentionSource`、`findTargetLink`、`verifyWebmention`、
   `createWebmentionSourceFetcher`
 - `WebmentionSection`、`getWebmentionSectionData`、`getWebmentionsForEntry`、

package/dist/components/webmention-section.d.ts

@@ -6,3 +6,5 @@ export type WebmentionSectionProps = {
 };
 declare const WebmentionSection: ({ mentions, heading, className, }: Readonly<WebmentionSectionProps>) => import("hono/jsx/jsx-dev-runtime").JSX.Element;
 export default WebmentionSection;
+export type ArticleWebmentionSectionProps = Omit<WebmentionSectionProps, "mentions">;
+export declare function ArticleWebmentionSection(props: Readonly<ArticleWebmentionSectionProps>): Promise<any[] | import("hono/utils/html").HtmlEscapedString>;

package/dist/components/webmention-section.js

@@ -1,3 +1,75 @@
+// components/webmention-section.tsx
+import { resolvePlugins } from "@riebeckite/core";
+import { useArticleContext, useSiteContext } from "@riebeckite/ui";
+
+// src/provider.ts
+function supportsWebmentionCapability(provider, capability) {
+  return provider.capabilities.has(capability);
+}
+
+// src/url.ts
+function normalizeWebmentionUrl(value) {
+  let url;
+  try {
+    url = new URL(value);
+  } catch {
+    return null;
+  }
+  if (url.protocol !== "http:" && url.protocol !== "https:") return null;
+  if (url.username !== "" || url.password !== "") return null;
+  url.hash = "";
+  url.hostname = url.hostname.toLowerCase();
+  return url.toString();
+}
+function resolvePublicUrl(permalink, baseUrl) {
+  try {
+    return new URL(permalink, baseUrl ?? "https://example.invalid").toString();
+  } catch {
+    return null;
+  }
+}
+
+// src/targets.ts
+function entryPublicUrl(entry, config) {
+  if (config?.site.baseUrl) {
+    return resolvePublicUrl(entry.permalink, config.site.baseUrl);
+  }
+  return normalizeWebmentionUrl(entry.permalink);
+}
+
+// src/server.ts
+var getWebmentionSectionData = async ({
+  view,
+  slug,
+  config,
+  provider,
+  heading = "Mentions",
+  className = "rr-webmention",
+  limit
+}) => {
+  const entry = view.findRoutableBySlug(slug);
+  if (!entry || !supportsWebmentionCapability(provider, "query")) {
+    return { mentions: [], heading, className };
+  }
+  const target = entryPublicUrl(entry, config);
+  if (target === null) return { mentions: [], heading, className };
+  const result = await provider.query({
+    type: "mentions_for_target",
+    target,
+    limit
+  });
+  return {
+    mentions: [...result.mentions].sort(compareMentions),
+    heading,
+    className
+  };
+};
+function compareMentions(left, right) {
+  return (right.publishedAt ?? right.verifiedAt).localeCompare(
+    left.publishedAt ?? left.verifiedAt
+  ) || left.source.localeCompare(right.source);
+}
+
 // components/webmention-section.tsx
 import { jsx, jsxs } from "hono/jsx/jsx-runtime";
 var WebmentionSection = (({
@@ -40,6 +112,29 @@ var WebmentionSection = (({
   );
 });
 var webmention_section_default = WebmentionSection;
+async function ArticleWebmentionSection(props) {
+  const site = useSiteContext();
+  const article = useArticleContext();
+  if (!site || !article?.entry) return [];
+  const provider = findProvider(site.config.plugins);
+  if (!provider) return [];
+  const data = await getWebmentionSectionData({
+    view: site.view,
+    slug: article.entry.slug,
+    config: site.config,
+    provider,
+    heading: props.heading,
+    className: props.className
+  });
+  return /* @__PURE__ */ jsx(WebmentionSection, { ...data });
+}
+function findProvider(plugins) {
+  const options = resolvePlugins([...plugins]).find(
+    (plugin) => plugin.name === "webmention"
+  )?.options;
+  return options?.provider;
+}
 export {
+  ArticleWebmentionSection,
   webmention_section_default as default
 };

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { buildWebmentionDiagnostics } from "./src/diagnostics.js";
 import type { WebmentionOptions } from "./src/types.js";
-export type { WebmentionSectionProps } from "./components/webmention-section.js";
-export { default as WebmentionSection } from "./components/webmention-section.js";
+export type { ArticleWebmentionSectionProps, WebmentionSectionProps, } from "./components/webmention-section.js";
+export { ArticleWebmentionSection, default as WebmentionSection, } from "./components/webmention-section.js";
 export { createWebmentionEndpoints } from "./src/endpoints.js";
 export type { WebmentionFeed, WebmentionFeedEntry, WebmentionFeedMention, } from "./src/feed.js";
 export { buildFeed, createWebmentionFeedHandler, summarizeEntry, } from "./src/feed.js";
@@ -24,8 +24,6 @@ export { normalizeWebmentionUrl, resolvePublicUrl, urlComparisonKey, } from "./s
 export type { WebmentionRejectionReason, WebmentionSourceDocument, WebmentionSourceFetcher, WebmentionSourceFetcherOptions, WebmentionVerification, } from "./src/verify.js";
 export { createWebmentionSourceFetcher, DEFAULT_WEBMENTION_MAX_BYTES, DEFAULT_WEBMENTION_TIMEOUT_MS, DEFAULT_WEBMENTION_USER_AGENT, verifyWebmention, } from "./src/verify.js";
 export type { WebmentionOptions as WebmentionPluginOptions };
-/** Alias matching the `*Plugin` suffix used by other plugin factories. */
-export declare const webmentionPlugin: typeof webmention;
 /**
  * Receives Webmentions and displays verified ones as "mentions" near articles.
  *

package/dist/index.js

@@ -1055,6 +1055,8 @@ function compareMentions2(left, right) {
 }
 
 // components/webmention-section.tsx
+import { resolvePlugins } from "@riebeckite/core";
+import { useArticleContext, useSiteContext } from "@riebeckite/ui";
 import { jsx, jsxs } from "hono/jsx/jsx-runtime";
 var WebmentionSection = (({
   mentions,
@@ -1096,6 +1098,28 @@ var WebmentionSection = (({
   );
 });
 var webmention_section_default = WebmentionSection;
+async function ArticleWebmentionSection(props) {
+  const site = useSiteContext();
+  const article = useArticleContext();
+  if (!site || !article?.entry) return [];
+  const provider = findProvider(site.config.plugins);
+  if (!provider) return [];
+  const data = await getWebmentionSectionData({
+    view: site.view,
+    slug: article.entry.slug,
+    config: site.config,
+    provider,
+    heading: props.heading,
+    className: props.className
+  });
+  return /* @__PURE__ */ jsx(WebmentionSection, { ...data });
+}
+function findProvider(plugins) {
+  const options = resolvePlugins([...plugins]).find(
+    (plugin) => plugin.name === "webmention"
+  )?.options;
+  return options?.provider;
+}
 
 // src/render.ts
 import { escapeHtml, escapeHtmlAttribute } from "@riebeckite/core";
@@ -1132,7 +1156,6 @@ function formatDate(value) {
 }
 
 // index.ts
-var webmentionPlugin = webmention;
 function webmention(options = {}) {
   const resolved = resolveWebmentionOptions(options);
   const provider = resolved.provider;
@@ -1221,6 +1244,7 @@ function webmention(options = {}) {
   });
 }
 export {
+  ArticleWebmentionSection,
   DEFAULT_WEBMENTION_CLASS_NAME,
   DEFAULT_WEBMENTION_ENDPOINT,
   DEFAULT_WEBMENTION_HEADING_TEXT,
@@ -1266,6 +1290,5 @@ export {
   verifyWebmention,
   webmention,
   webmentionKey,
-  webmentionPlugin,
   webmentionTypeForRels
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-webmention",
-  "version": "0.0.31",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -21,8 +21,9 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "hono": "^4.12.25",
-    "@riebeckite/core": "0.0.31"
+    "@riebeckite/core": "0.0.33",
+    "@riebeckite/ui": "0.0.33",
+    "hono": "^4.12.25"
   },
   "devDependencies": {
     "tsx": "^4.22.4"