@piyoraik/ffxiv-lodestone-character-lookup 1.0.1 → 1.0.3

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.
Files changed (2) hide show
  1. package/README.md +33 -61
  2. package/package.json +3 -3
package/README.md CHANGED
@@ -17,8 +17,7 @@ FFXIV の Lodestone を使って、以下を行うための共通ライブラリ
17
17
  yarn add @piyoraik/ffxiv-lodestone-character-lookup
18
18
  ```
19
19
 
20
- ## 最短の使い方（募集者 → Lodestone URL → クリア判定）
21
-
20
+ ## 使い方
22
21
  ```ts
23
22
  import {
24
23
  parseCreator,
@@ -52,65 +51,38 @@ console.log(result);
52
51
 
53
52
  ## 公開API（関数の挙動）
54
53
 
55
- ### `parseCreator(creator: string): { name: string; world: string } | undefined`
56
-
57
- `募集者: キャラクター名 @ サーバー名` 形式の文字列から、`name` と `world` を抽出します。
58
-
59
- - 入力例: `"Hoge Fuga @ World"`
60
- - 出力例: `{ name: "Hoge Fuga", world: "World" }`
61
- - 形式が不正な場合は `undefined` を返します（`@` がない、名前/ワールドが空、など）
62
-
63
- ### `buildLodestoneSearchUrl(info: { name: string; world: string }): string`
64
-
65
- Lodestone のキャラクター検索URLを生成します。
66
-
67
- - `q`（キャラクター名）と `worldname`（サーバー名）を指定し、その他は Lodestone のフォーム送信に近い値を付与します
68
- - 返り値はURL文字列です（`https://jp.finalfantasyxiv.com/lodestone/character/?...`）
69
-
70
- ### `fetchTopCharacterUrl(searchUrl: string): Promise<string | undefined>`
71
-
72
- `buildLodestoneSearchUrl` で作ったURLにアクセスし、検索結果の先頭に表示されるキャラクターURLを返します。
73
-
74
- - 返り値例: `https://jp.finalfantasyxiv.com/lodestone/character/1234567/`
75
- - 先頭ヒットが見つからない場合は `undefined`
76
- - 取得は `axios` で行い、`timeout: 30_000` を設定しています
77
-
78
- 内部では、検索結果HTMLから `a.entry__link` の先頭を見ています。
79
-
80
- ### `buildAchievementCategoryUrl(characterUrl: string): string | undefined`
81
-
82
- キャラクターURL（`.../lodestone/character/<id>/`）から、アチーブページ（カテゴリ4）のURLを生成します。
83
-
84
- - 生成例: `https://jp.finalfantasyxiv.com/lodestone/character/1234567/achievement/category/4/#anchor_achievement`
85
- - `characterUrl` からIDが抽出できない場合は `undefined`
86
-
87
- ※ 互換用に `buildHighEndAchievementCategoryUrl` も同様のURLを返します。
88
-
89
- ### `fetchAchievementCategoryHtml(url: string): Promise<string>`
90
-
91
- アチーブメント一覧ページ（カテゴリ4）のHTMLを取得します。
92
-
93
- - 取得は `axios` で行い、`timeout: 30_000` を設定しています
94
-
95
- ### `parseUltimateClearsFromAchievementHtml(html: string): { status: "ok" | "private_or_unavailable"; clears: string[] }`
96
-
97
- アチーブメント一覧HTMLから、定義済みの高難度（絶/零式）アチーブの「達成済み」を抽出します。
98
-
99
- - 判定: 対象アチーブの項目に日付（`time.entry__activity__time`）が存在するか
100
- - `clears` は「正式名」の配列です（例: `"絶オメガ検証戦を完遂せし者"`）
101
- - `status` は次の意味です
102
- - `"ok"`: 対象アチーブの項目がページ内に存在した
103
- - `"private_or_unavailable"`: 対象項目が1つも見つからない（非公開などで一覧自体が出ていないケースを想定）
104
-
105
- ※ 互換用に `parseHighEndClearsFromAchievementHtml` も同じ結果を返します。
106
-
107
- ### `getHighEndAchievements() / getHighEndAchievementShortMap() / getHighEndAchievementGroupMap()`
108
-
109
- ライブラリ同梱の高難度アチーブ定義（絶/零式）を返します。
110
-
111
- - `getHighEndAchievements()` は `{ name, short, group }[]` を返します
112
- - `getHighEndAchievementShortMap()` は `正式名 -> 略称` の `Map` を返します
113
- - `getHighEndAchievementGroupMap()` は `正式名 -> "ultimate" | "savage"` の `Map` を返します
54
+ ## API一覧（概要）
55
+
56
+ | 関数 | 返り値 | 用途 |
57
+ |---|---|---|
58
+ | `parseCreator(creator)` | `{ name, world } \| undefined` | `Name @ World` を分解 |
59
+ | `buildLodestoneSearchUrl(info)` | `string` | キャラクター検索URLを生成 |
60
+ | `fetchTopCharacterUrl(searchUrl)` | `Promise<string \| undefined>` | 検索結果の先頭ヒットのキャラURLを取得 |
61
+ | `buildAchievementCategoryUrl(characterUrl)` | `string \| undefined` | カテゴリ4(レイド)のアチーブURLを生成 |
62
+ | `fetchAchievementCategoryHtml(url)` | `Promise<string>` | アチーブHTMLを取得 |
63
+ | `parseUltimateClearsFromAchievementHtml(html)` | `{ status, clears }` | 高難度（絶/零式）達成状況を抽出 |
64
+ | `getHighEndAchievements()` | `HighEndAchievementDefinition[]` | 同梱定義（正式名/略称/種別）を取得 |
65
+ | `getHighEndAchievementShortMap()` | `Map<string, string>` | `正式名 -> 略称` |
66
+ | `getHighEndAchievementGroupMap()` | `Map<string, "ultimate" \| "savage">` | `正式名 -> 種別` |
67
+
68
+ ## 対応アチーブメント（高難度）
69
+
70
+ このライブラリが達成判定に対応しているアチーブメントの一覧です（`getHighEndAchievements()` の内容と同じ）。
71
+
72
+ | 種別 | 略称 | 正式名 |
73
+ |---|---|---|
74
+ | 絶 | 絶バハ | 絶バハムートを狩りし者 |
75
+ | 絶 | 絶テマ | 絶アルテマウェポンを破壊せし者 |
76
+ | 絶 | 絶アレキ | 絶アレキサンダーを破壊せし者 |
77
+ | 絶 | 絶竜詩 | 絶竜詩戦争を平定せし者 |
78
+ | 絶 | 絶オメガ | 絶オメガ検証戦を完遂せし者 |
79
+ | 絶 | 絶エデン | 絶もうひとつの未来を見届けし者 |
80
+ | 零式 | 【パンデモ】辺獄 | 万魔殿の辺獄を完全制覇せし者：ランク1 |
81
+ | 零式 | 【パンデモ】煉獄 | 万魔殿の煉獄を完全制覇せし者：ランク1 |
82
+ | 零式 | 【パンデモ】天獄 | 万魔殿の天獄を完全制覇せし者：ランク1 |
83
+ | 零式 | 【アルカディア】ライトヘビー | アルカディアのライトヘビー級を制覇せし者：ランク1 |
84
+ | 零式 | 【アルカディア】クルーザー | アルカディアのクルーザー級を完全制覇せし者：ランク1 |
85
+ | 零式 | 【アルカディア】ヘビー | アルカディアのヘビー級を完全制覇せし者：ランク1 |
114
86
 
115
87
  ## 注意
116
88
 
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@piyoraik/ffxiv-lodestone-character-lookup",
3
- "version": "1.0.1",
3
+ "version": "1.0.3",
4
4
  "description": "FFXIV Lodestone character lookup (search → character URL) and high-end achievement checks",
5
5
  "license": "MIT",
6
6
  "author": "",
7
- "homepage": "",
7
+ "homepage": "https://github.com/piyoraik/ffxiv-lodestone-character-lookup",
8
8
  "repository": {
9
9
  "type": "git",
10
- "url": ""
10
+ "url": "git+https://github.com/piyoraik/ffxiv-lodestone-character-lookup.git"
11
11
  },
12
12
  "type": "commonjs",
13
13
  "main": "dist/index.js",