@riebeckite/plugin-rich-embed 0.0.32 → 0.0.33

package/README.md

@@ -75,6 +75,15 @@ listed in `allowHosts`.
 | `providers` | `RichEmbedProvider[]` | all | Allowlist of providers to enable |
 | `disable` | `RichEmbedProvider[]` | `[]` | Providers to disable (wins over `providers`) |
 
+## Live example
+
+~~~embed
+https://www.youtube.com/watch?v=dQw4w9WgXcQ
+title: Demo video
+caption: A short caption
+aspect: 16/9
+~~~
+
 ## Output HTML
 
 ```html
@@ -136,7 +145,7 @@ warning through the vfile message channel:
 ## Exports
 
 - `richEmbed(options?)` — plugin factory
-- `richEmbedPlugin` — alias of `richEmbed`
+- `richEmbed` — alias of `richEmbed`
 - Types: `RichEmbedOptions`, `RichEmbedProvider`
 
 ## See also

package/README_ja.md

@@ -9,7 +9,7 @@
 ## 概要
 
 `richEmbed()` は ` ```embed ` フェンスをレスポンシブな
-`<figure class="rb-rich-embed">` に置き換えます。プロバイダの判定は URL の文字列解析だけで行うため、ビルド時にネットワークへアクセスしません。クライアント側 JavaScript も不要です。
+`<figure class="rb-rich-embed">` に置き換えます。プロバイダーの判定は URL の文字列解析だけで行うため、ビルド時にネットワークへアクセスしません。クライアント側 JavaScript も不要です。
 
 ## 使い方
 
@@ -50,9 +50,9 @@ start: 30
 
 未知のキーは無視します。`aspect` が不正な場合は `16/9` に戻します。
 
-## 対応プロバイダ
+## 対応プロバイダー
 
-| プロバイダ | 認識する URL | 出力する `src` |
+| プロバイダー | 認識する URL | 出力する `src` |
 | ---------- | ------------ | -------------- |
 | YouTube | `youtube.com/watch?v=`, `youtu.be/`, `/shorts/`, `/embed/`, `/live/` | `https://www.youtube-nocookie.com/embed/<id>` |
 | Vimeo | `vimeo.com/<数値ID>` | `https://player.vimeo.com/video/<id>` |
@@ -66,9 +66,18 @@ start: 30
 
 | オプション | 型 | 既定値 | 説明 |
 | ---------- | -- | ------ | ---- |
-| `allowHosts` | `string[]` | `[]` | 汎用 iframe へのフォールバックを許可するホスト名 |
-| `providers` | `RichEmbedProvider[]` | すべて | 有効にするプロバイダの許可リスト |
-| `disable` | `RichEmbedProvider[]` | `[]` | 無効にするプロバイダ（`providers` より優先） |
+| `allowHosts` | `string[]` | `[]` | 汎用 `<iframe>` へのフォールバックを許可するホスト名 |
+| `providers` | `RichEmbedProvider[]` | すべて | 有効にするプロバイダーの許可リスト |
+| `disable` | `RichEmbedProvider[]` | `[]` | 無効にするプロバイダー（`providers` より優先） |
+
+## 実行例
+
+~~~embed
+https://www.youtube.com/watch?v=dQw4w9WgXcQ
+title: Demo video
+caption: A short caption
+aspect: 16/9
+~~~
 
 ## 出力 HTML
 
@@ -113,8 +122,8 @@ Gist の場合は iframe の代わりに
 ## セキュリティ
 
 - `https:` の URL だけを受理します。
-- プロバイダの出力は検証済みのパスセグメントから組み立て、動的な部分は `encodeURIComponent` を通します。
-- 汎用 iframe には `allowHosts` への明示的な登録が必要です。
+- プロバイダーの出力は検証済みのパスセグメントから組み立て、動的な部分は `encodeURIComponent` を通します。
+- 汎用 `<iframe>` には `allowHosts` への明示的な登録が必要です。
 - 生のユーザー HTML は出力しません。タイトル・キャプション・ラベルはすべてエスケープされるテキストノードとして書き込みます。
 
 ## 制限事項
@@ -126,7 +135,7 @@ Gist の場合は iframe の代わりに
 ## エクスポート
 
 - `richEmbed(options?)`：プラグインファクトリ
-- `richEmbedPlugin`：`richEmbed` の別名
+- `richEmbed`：`richEmbed` の別名
 - 型: `RichEmbedOptions`, `RichEmbedProvider`
 
 ## 関連

package/dist/index.d.ts

@@ -1,4 +1,3 @@
 import type { RichEmbedOptions } from "./src/types.js";
 export type { RichEmbedOptions, RichEmbedProvider } from "./src/types.js";
 export declare function richEmbed(options?: RichEmbedOptions): import("@riebeckite/core").RiebeckitePlugin<RichEmbedOptions>;
-export declare const richEmbedPlugin: typeof richEmbed;

package/dist/index.js

@@ -218,7 +218,6 @@ function parseStart(value) {
 // src/hast.ts
 import {
   element as sharedElement,
-  getStringProperty as sharedGetStringProperty,
   getTextContent as sharedGetTextContent,
   hasClass as sharedHasClass,
   text as sharedText,
@@ -352,7 +351,6 @@ function richEmbed(options = {}) {
     ]
   });
 }
-var richEmbedPlugin = richEmbed;
 function validateRichEmbedOptions(options) {
   if (!options) return [];
   const issues = [];
@@ -403,6 +401,5 @@ function isRichEmbedProvider(value) {
   return typeof value === "string" && RICH_EMBED_PROVIDERS.includes(value);
 }
 export {
-  richEmbed,
-  richEmbedPlugin
+  richEmbed
 };

package/dist/src/hast.d.ts

@@ -2,6 +2,5 @@ import type { ElementNode, HastNode, ParentNode, TextNode } from "./types.js";
 export declare const element: (tagName: string, properties?: Record<string, unknown>, children?: HastNode[]) => ElementNode;
 export declare const text: (value: string) => TextNode;
 export declare const getTextContent: (node: HastNode) => string;
-export declare const getStringProperty: (node: ElementNode, key: string) => string | null;
 export declare const hasClass: (node: ElementNode, className: string) => boolean;
 export declare const visitElements: (node: HastNode, visitor: (node: ElementNode, parent?: ParentNode, index?: number) => void, parent?: ParentNode, index?: number) => void;

package/dist/src/providers.d.ts

@@ -1,11 +1,10 @@
 import type { RichEmbedBlockOptions, RichEmbedOptions, RichEmbedProvider } from "./types.js";
 export declare const RICH_EMBED_PROVIDERS: readonly RichEmbedProvider[];
-export declare const DEFAULT_ASPECT = "16/9";
-export type ParsedEmbedBlock = {
+type ParsedEmbedBlock = {
     url: string;
     options: RichEmbedBlockOptions;
 };
-export type EmbedResolution = {
+type EmbedResolution = {
     kind: "iframe";
     provider: RichEmbedProvider;
     src: string;
@@ -30,9 +29,9 @@ export type SupportedEmbedResolution = Exclude<EmbedResolution, {
  * every following `key: value` line is an option.
  */
 export declare function parseEmbedBlock(source: string): ParsedEmbedBlock | null;
-export declare function normalizeAspect(value: string): string | null;
 /**
  * Resolves a URL to an embeddable target using only string inspection. No
  * network request is performed.
  */
 export declare function resolveEmbed(urlText: string, block: RichEmbedBlockOptions, config: RichEmbedOptions): EmbedResolution;
+export {};

package/dist/src/types.d.ts

@@ -39,7 +39,7 @@ export type TextNode = {
     type: "text";
     value: string;
 };
-export type RawNode = {
+type RawNode = {
     type: "raw";
     value: string;
 };
@@ -47,3 +47,4 @@ export type HastNode = ElementNode | TextNode | RawNode | {
     type: string;
     [key: string]: unknown;
 };
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@riebeckite/plugin-rich-embed",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./dist/index.js",
@@ -15,8 +15,8 @@
     "./style.css": "./style.css"
   },
   "dependencies": {
-    "@riebeckite/core": "0.0.32",
-    "@riebeckite/diagram": "0.0.32"
+    "@riebeckite/core": "0.0.33",
+    "@riebeckite/diagram": "0.0.33"
   },
   "publishConfig": {
     "access": "public"