@riebeckite/plugin-map 0.0.6

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright Rerurate_514
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,176 @@
+# @riebeckite/plugin-map
+
+Turns a ` ```map ` fenced code block and/or frontmatter coordinates into an
+embedded map. The page is rendered with a static fallback first (coordinates,
+place name, OpenStreetMap links, and an optional static image), and upgraded to
+an interactive Leaflet map in the browser only when a map is present.
+
+[日本語](./README_ja.md)
+
+## Configure
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { map } from "@riebeckite/plugin-map";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    map({
+      zoom: 13,
+      height: 320,
+      // Keyless default; see "Tiles and attribution" before changing it.
+      tileUrl: "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
+      attribution:
+        '&copy; <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors',
+    }),
+  ],
+});
+```
+
+The plugin runs with `order: -10`.
+
+## Syntax
+
+### Fenced code block
+
+The block body is a small key/value format. A marker list follows `markers:` as
+bullets, and a bare `lat, lng` line is an implicit marker.
+
+````markdown
+```map
+center: 35.6812, 139.7671
+zoom: 13
+label: Tokyo Station
+markers:
+  - 35.6812, 139.7671 | Tokyo Station
+  - 35.6586, 139.7454 | Tokyo Tower | A lattice tower
+```
+````
+
+Marker lines use `lat, lng` or `lat, lng | label | description`. The block
+`title` becomes the caption when present.
+
+### Frontmatter
+
+Coordinates in frontmatter produce one map at the top of the article. The
+property name defaults to `map` and is configurable with `frontmatterKey`.
+
+```yaml
+---
+title: A trip
+map:
+  lat: 35.6812
+  lng: 139.7671
+  zoom: 13
+  label: Tokyo Station
+  markers:
+    - 35.6812, 139.7671 | Tokyo Station
+    - lat: 35.6586
+      lng: 139.7454
+      label: Tokyo Tower
+---
+```
+
+`lat`/`lng` also accept `latitude`/`longitude`, `coordinates: [lat, lng]` or
+`coordinates: "lat, lng"`, and `label` also accepts `title`/`place`/`name`.
+
+## How it renders
+
+A block or frontmatter map becomes a `figure.rr-map`:
+
+- `figure.rr-map`: carries `data-rr-map="pending"` and
+  `data-rr-map-payload` (the resolved map data as JSON)
+- `div.rr-map__canvas [data-rr-map-canvas]`: the element Leaflet renders into
+- `figcaption.rr-map__caption`: the caption, when present
+- `div.rr-map__static`: the always-available fallback, with
+  `p.rr-map__place`, `ul.rr-map__markers` → `a.rr-map__link` (OpenStreetMap
+  links), an optional `img.rr-map__image`, and `p.rr-map__attribution`
+- `details.rr-map__fallback`: the raw block source, folded away
+
+`initMap` finds every `[data-rr-map="pending"]`, loads Leaflet lazily, draws the
+tile layer and markers, and flips the figure to `data-rr-map="rendered"` (the
+static fallback is then hidden). On failure the figure becomes
+`data-rr-map="error"`, the `details` block opens, and the static fallback stays
+visible.
+
+A block with no coordinates and no `center` is left as a normal code block, and
+a diagnostic with `source: "@riebeckite/plugin-map"` is emitted.
+
+## Options
+
+| Option | Default | Description |
+| --- | --- | --- |
+| `language` | `"map"` | Fenced-code language to recognize |
+| `className` | `"rr-map"` | Base class applied to the figure |
+| `height` | `320` | Map height in pixels |
+| `zoom` | `13` | Default zoom level (0–19) |
+| `minZoom` | `1` | Minimum zoom level |
+| `maxZoom` | `19` | Maximum zoom level |
+| `tileUrl` | OpenStreetMap standard tiles | Tile URL template (`{z}`/`{x}`/`{y}`) |
+| `attribution` | OpenStreetMap attribution | Attribution HTML required by the provider |
+| `fallback` | `true` | Render the `<details>` block with the raw source |
+| `staticFallback` | `true` | Render the static fallback block |
+| `staticImageUrl` | — | Static image URL template (`{lat}`/`{lng}`/`{zoom}`/`{width}`/`{height}`) |
+| `frontmatterKey` | `"map"` | Frontmatter property read for coordinates |
+
+## Tiles and attribution
+
+The default is the keyless
+[OpenStreetMap standard tile layer](https://tile.openstreetmap.org/). It is fine
+for low-traffic sites, but OpenStreetMap's
+[tile usage policy](https://operations.osmfoundation.org/policies/tiles/)
+expects a valid identifying referrer and forbids bulk or heavy use. Sites with
+meaningful traffic should point `tileUrl` at their own tile server or a
+commercial provider.
+
+Attribution is not optional. `attribution` is passed to Leaflet and rendered in
+the static fallback (as plain text). Keep the provider's required credit visible.
+
+The plugin ships no API keys or credentials. If a provider's tile or static
+image URL needs a key, that key travels to the browser and is therefore public;
+prefer a keyless server or a proxy that keeps the key server-side. Only the
+tile URL, attribution, and zoom bounds are exposed through `publicConfig`; no
+plugin option is copied there implicitly.
+
+## Client rendering
+
+Leaflet (`leaflet.js` + `leaflet.css`) is fetched from jsDelivr only when at
+least one `[data-rr-map="pending"]` figure exists. Because the library is loaded
+lazily, pages without maps pay nothing, and pages with maps still show the
+static fallback when JavaScript is disabled or the CDN is unreachable.
+
+`initMap(options?)` accepts `tileUrl`, `attribution`, `minZoom`, `maxZoom`,
+`leafletScriptUrl`, `leafletStyleUrl`, and a preloaded `runtime` (used by tests
+to inject a fake Leaflet).
+
+## Output hooks
+
+- `figure[data-rr-map]`: state (`pending` / `rendered` / `error`)
+- `figure[data-rr-map-payload]`: resolved map data as JSON
+- `[data-rr-map-canvas]`: Leaflet render target
+- `[data-rr-map-static]`: static fallback block
+- `details.rr-map__fallback`: raw block source
+
+## Main exports
+
+- `map(options?)`: create the plugin (`mapPlugin` is an alias)
+- `initMap`: initialize client-side maps
+- `parseMapSource`: parse a fenced block into `MapData`
+- `normalizeMapInput`: normalize frontmatter into `MapData`
+- `describeMap`, `formatCoordinates`, `openStreetMapUrl`
+- Types: `MapOptions`, `MapData`, `MapMarker`, `MapPayload`, `MapClientOptions`
+
+## Limitations
+
+- Rendering is client-only. Without JavaScript the page shows the static
+  fallback (coordinates, place, OpenStreetMap links, optional image) but no
+  interactive map.
+- The first interactive render waits on the CDN for Leaflet and the tiles.
+- The tile provider's terms and attribution are the site owner's responsibility.
+- Leaflet is BSD-2-Clause licensed; the default OpenStreetMap tiles are
+  © OpenStreetMap contributors (ODbL).
+
+## See also
+
+- [Plugin system](../../../docs/en/plugin-system.md)

package/README_ja.md

@@ -0,0 +1,142 @@
+# @riebeckite/plugin-map
+
+` ```map ` コードブロックや frontmatter の座標を、埋め込み地図に変換するプラグインです。まず静的フォールバック（座標・場所名・OpenStreetMap リンク・任意の静的画像）を描画し、地図があるページだけブラウザ側で Leaflet によるインタラクティブ地図に拡張します。
+
+[English](./README.md)
+
+## 設定する
+
+```ts
+import { defineConfig } from "@riebeckite/core";
+import { map } from "@riebeckite/plugin-map";
+
+export default defineConfig({
+  // ...
+  plugins: [
+    map({
+      zoom: 13,
+      height: 320,
+      // 既定はキー不要の OpenStreetMap。変更前に「タイルと帰属表示」を参照。
+      tileUrl: "https://tile.openstreetmap.org/{z}/{x}/{y}.png",
+      attribution:
+        '&copy; <a href="https://www.openstreetmap.org/copyright">OpenStreetMap</a> contributors',
+    }),
+  ],
+});
+```
+
+このプラグインは `order: -10` で実行されます。
+
+## 記法
+
+### コードブロック
+
+ブロック本文は小さな key/value 形式です。`markers:` の後に `-` でマーカーを並べ、`lat, lng` だけの行は暗黙のマーカーになります。
+
+````markdown
+```map
+center: 35.6812, 139.7671
+zoom: 13
+label: Tokyo Station
+markers:
+  - 35.6812, 139.7671 | Tokyo Station
+  - 35.6586, 139.7454 | Tokyo Tower | A lattice tower
+```
+````
+
+マーカー行は `lat, lng` または `lat, lng | ラベル | 説明` です。コードブロックの `title` がある場合はキャプションになります。
+
+### frontmatter
+
+frontmatter の座標は、記事の先頭に 1 つの地図を生成します。プロパティ名は既定で `map` で、`frontmatterKey` で変更できます。
+
+```yaml
+---
+title: A trip
+map:
+  lat: 35.6812
+  lng: 139.7671
+  zoom: 13
+  label: Tokyo Station
+  markers:
+    - 35.6812, 139.7671 | Tokyo Station
+    - lat: 35.6586
+      lng: 139.7454
+      label: Tokyo Tower
+---
+```
+
+`lat`/`lng` は `latitude`/`longitude`、`coordinates: [lat, lng]` または `coordinates: "lat, lng"` も受け付けます。`label` は `title`/`place`/`name` も使えます。
+
+## どのように描画されるか
+
+コードブロックまたは frontmatter の地図は `figure.rr-map` になります。
+
+- `figure.rr-map`: `data-rr-map="pending"` と `data-rr-map-payload`（解決済みの地図データ JSON）を持ちます
+- `div.rr-map__canvas [data-rr-map-canvas]`: Leaflet が描画する領域
+- `figcaption.rr-map__caption`: キャプション（ある場合）
+- `div.rr-map__static`: 常に利用できるフォールバック。`p.rr-map__place`、`ul.rr-map__markers` → `a.rr-map__link`（OpenStreetMap リンク）、任意の `img.rr-map__image`、`p.rr-map__attribution` を含みます
+- `details.rr-map__fallback`: 元のブロック本文を折りたたんで表示
+
+`initMap` は `[data-rr-map="pending"]` を探し、Leaflet を遅延して読み込み、タイルレイヤーとマーカーを描画して `data-rr-map="rendered"` にします（このとき静的フォールバックは非表示になります）。失敗した場合は `data-rr-map="error"` になり、`details` を開き、静的フォールバックは表示されたままです。
+
+座標も `center` もないブロックは置き換えず、通常のコードブロックのまま残し、`source: "@riebeckite/plugin-map"` を持つ診断を出します。
+
+## オプション
+
+| 項目 | 既定値 | 説明 |
+| --- | --- | --- |
+| `language` | `"map"` | 対象にするコードブロックの言語 |
+| `className` | `"rr-map"` | figure に付ける基準クラス |
+| `height` | `320` | 地図の高さ（ピクセル） |
+| `zoom` | `13` | 既定のズームレベル（0〜19） |
+| `minZoom` | `1` | 最小ズームレベル |
+| `maxZoom` | `19` | 最大ズームレベル |
+| `tileUrl` | OpenStreetMap 標準タイル | タイル URL テンプレート（`{z}`/`{x}`/`{y}`） |
+| `attribution` | OpenStreetMap の帰属表示 | プロバイダが要求する帰属表示の HTML |
+| `fallback` | `true` | 元の本文を表示する `details` を描画する |
+| `staticFallback` | `true` | 静的フォールバックのブロックを描画する |
+| `staticImageUrl` | — | 静的画像 URL テンプレート（`{lat}`/`{lng}`/`{zoom}`/`{width}`/`{height}`） |
+| `frontmatterKey` | `"map"` | 座標を読む frontmatter プロパティ |
+
+## タイルと帰属表示
+
+既定はキー不要の [OpenStreetMap 標準タイル](https://tile.openstreetmap.org/) です。小規模なサイトには十分ですが、OpenStreetMap の[タイル利用ポリシー](https://operations.osmfoundation.org/policies/tiles/)は識別可能な referrer を前提とし、大量アクセスを禁止しています。一定のトラフィックがあるサイトは `tileUrl` を自前のタイルサーバーや商用プロバイダに向けてください。
+
+帰属表示は省略できません。`attribution` は Leaflet に渡され、静的フォールバックにも（プレーンテキストで）描画されます。プロバイダが要求するクレジットを常に表示してください。
+
+このプラグインは API キーや資格情報を同梱しません。タイル URL や静的画像 URL にキーが必要な場合、そのキーはブラウザへ送られるため公開情報になります。キー不要のサーバーか、キーをサーバー側に保持するプロキシを使ってください。`publicConfig` に公開されるのはタイル URL・帰属表示・ズーム範囲だけで、プラグインのオプションが暗黙にコピーされることはありません。
+
+## クライアント側の描画
+
+Leaflet（`leaflet.js` と `leaflet.css`）は、`[data-rr-map="pending"]` の figure が 1 つ以上あるときだけ jsDelivr から取得します。ライブラリを遅延して読み込むため、地図のないページは何も負担せず、地図のあるページも JavaScript を無効にしていたり CDN に到達できなかったりする場合は静的フォールバックが表示されます。
+
+`initMap(options?)` は `tileUrl`、`attribution`、`minZoom`、`maxZoom`、`leafletScriptUrl`、`leafletStyleUrl`、および事前読み込み済みの `runtime`（テストで偽の Leaflet を注入する用途）を受け取ります。
+
+## 出力のフック
+
+- `figure[data-rr-map]`: 状態（`pending` / `rendered` / `error`）
+- `figure[data-rr-map-payload]`: 解決済みの地図データ JSON
+- `[data-rr-map-canvas]`: Leaflet の描画先
+- `[data-rr-map-static]`: 静的フォールバックのブロック
+- `details.rr-map__fallback`: 元のブロック本文
+
+## 主なエクスポート
+
+- `map(options?)`: プラグインを作成する（`mapPlugin` は別名）
+- `initMap`: クライアント側の地図を初期化する
+- `parseMapSource`: コードブロックを `MapData` に変換する
+- `normalizeMapInput`: frontmatter を `MapData` に正規化する
+- `describeMap`、`formatCoordinates`、`openStreetMapUrl`
+- 型: `MapOptions`、`MapData`、`MapMarker`、`MapPayload`、`MapClientOptions`
+
+## 制限
+
+- 描画はクライアント側のみです。JavaScript が無効な環境では、静的フォールバック（座標・場所・OpenStreetMap リンク・任意の画像）は表示されますが、インタラクティブな地図は表示されません
+- 最初の描画は Leaflet とタイルの CDN 取得を待ちます
+- タイルプロバイダの利用規約と帰属表示はサイト運営者の責任です
+- Leaflet は BSD-2-Clause、既定の OpenStreetMap タイルは © OpenStreetMap contributors（ODbL）です
+
+## 関連資料
+
+- [プラグインシステム](../../../docs/ja/plugin-system.md)

package/dist/client.d.ts

@@ -0,0 +1,2 @@
+export { initMap } from "./src/init.js";
+export type { MapClientOptions, MapPayload, MapRuntime, } from "./src/types.js";