ffxiv_ptfinder 1.0.1

package/Makefile

@@ -0,0 +1,16 @@
+.PHONY: build-PtfinderFunction
+
+# SAM build entrypoint for the function.
+build-PtfinderFunction:
+	@echo "==> Installing dependencies"
+	npm ci
+	@echo "==> Building TypeScript"
+	npm run -s build
+	@echo "==> Pruning devDependencies"
+	npm prune --omit=dev
+	@echo "==> Copying artifacts"
+	cp -R dist $(ARTIFACTS_DIR)/
+	cp -R data $(ARTIFACTS_DIR)/
+	cp package.json package-lock.json $(ARTIFACTS_DIR)/
+	cp -R node_modules $(ARTIFACTS_DIR)/
+

package/README.md

@@ -0,0 +1,83 @@
+# ffxiv_ptfinder
+
+FFXIV のパーティ募集（`https://xivpf.com/listings`）を定期取得し、条件に一致した募集を Discord Webhook に送信するツールです。  
+AWS SAM + EventBridge（30分間隔）での実行を前提にしています。
+
+## ざっくり仕様
+
+- 取得元: `https://xivpf.com/listings`（Cookie `lang=ja` を付与）
+- 対象DC: `Elemental` / `Mana` / `Meteor` / `Gaia`
+- 送信: 1募集 = 1メッセージ（Discord のコードブロック）
+- 送信件数上限: `FFXIV_PTFINDER_LIMIT`（デフォルト 5）
+- 募集者から Lodestone を検索し、先頭ヒットのURLを本文に含めます
+- Lodestone のアチーブページ（カテゴリ4）から「絶/零式」達成状況を判定して本文に含めます
+  - 判定: 対象アチーブの項目に日付（`time.entry__activity__time`）が存在するか
+
+## フィルタ（filter.json）
+
+検索条件は `data/filter.json` で管理します（複数行で編集しやすい形式）。  
+SAMデプロイ時もこのファイルが同梱され、Lambda 実行時に読み込まれます。
+
+例: `data/filter.json`
+
+```json
+{
+  "dutyTitle": { "terms": ["絶もうひとつの未来"], "mode": "and" },
+  "requirements": { "terms": ["練習"], "mode": "and" },
+  "party": {
+    "recruiting": {
+      "healer": ["白", "占"],
+      "withinRoleMode": "or",
+      "acrossRolesMode": "and"
+    }
+  },
+  "description": { "terms": ["最初から", "P1"], "mode": "or" }
+}
+```
+
+主なキー（抜粋）:
+
+- `dutyTitle`: コンテンツ名（部分一致, and/or）
+- `requirements`: 要件（`description` から `[Practice]` 等を抽出した日本語ラベル、部分一致, and/or）
+- `description`: 募集文（タグ除去後の本文、部分一致, and/or）
+- `party.recruiting`: 募集中ジョブ（表示に使う略称で指定。例: `白`/`占`/`侍`）
+  - `withinRoleMode`: 同一ロール内の OR/AND
+  - `acrossRolesMode`: 複数ロール指定時の OR/AND
+
+## 環境変数（Lambda）
+
+- `DISCORD_WEBHOOK_URL`（必須）: Discord Webhook URL
+- `FFXIV_PTFINDER_LIMIT`（任意）: 送信上限（デフォルト 5）
+- `FFXIV_PTFINDER_FILTER_FILE`（任意）: フィルタファイルパス（デフォルト `data/filter.json`）
+
+## ローカル実行
+
+### デバッグ（Webhook送信なし、JSON出力）
+
+`yarn start` で `https://xivpf.com/listings` を取得し、フィルタ（`data/filter.json`）を反映した募集一覧を JSON で標準出力に出します。
+
+### 通知（Webhook送信）
+
+```sh
+DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/..." yarn notify
+```
+
+## SAM デプロイ
+
+### ビルド
+
+```sh
+SAM_CLI_HOME=.samcli sam build
+```
+
+### 初回デプロイ
+
+```sh
+SAM_CLI_HOME=.samcli sam deploy --guided
+```
+
+`samconfig.toml` に設定が保存されるので、2回目以降は次で更新できます。
+
+```sh
+SAM_CLI_HOME=.samcli sam deploy
+```

package/data/description_tags_ja.json

@@ -0,0 +1,11 @@
+{
+  "version": 1,
+  "tags": [
+    { "token": "[Practice]", "label": "練習" },
+    { "token": "[Duty Completion]", "label": "コンプリート目的" },
+    { "token": "[Loot]", "label": "周回" },
+    { "token": "[One Player per Job]", "label": "ジョブ重複なし" },
+    { "token": "[Duty Complete]", "label": "コンプリート済み" }
+  ]
+}
+

package/data/filter.json

@@ -0,0 +1,21 @@
+{
+  "dutyTitle": {
+    "terms": ["絶もうひとつの未来"],
+    "mode": "or"
+  },
+  "requirements": {
+    "terms": ["練習"],
+    "mode": "and"
+  },
+  "party": {
+    "recruiting": {
+      "healer": ["白", "占"],
+      "withinRoleMode": "or",
+      "acrossRolesMode": "and"
+    }
+  },
+  "description": {
+    "terms": ["P2"],
+    "mode": "or"
+  }
+}

package/data/jobs_ja.json

@@ -0,0 +1,26 @@
+{
+  "version": 1,
+  "jobs": {
+    "DRK": { "short": "暗", "role": "tank" },
+    "PLD": { "short": "ナ", "role": "tank" },
+    "WAR": { "short": "戦", "role": "tank" },
+    "GNB": { "short": "ガ", "role": "tank" },
+    "AST": { "short": "占", "role": "healer" },
+    "SGE": { "short": "賢", "role": "healer" },
+    "SCH": { "short": "学", "role": "healer" },
+    "WHM": { "short": "白", "role": "healer" },
+    "VPR": { "short": "ヴ", "role": "dps" },
+    "DRG": { "short": "竜", "role": "dps" },
+    "MNK": { "short": "モ", "role": "dps" },
+    "NIN": { "short": "忍", "role": "dps" },
+    "SAM": { "short": "侍", "role": "dps" },
+    "RPR": { "short": "リ", "role": "dps" },
+    "MCH": { "short": "機", "role": "dps" },
+    "DNC": { "short": "踊", "role": "dps" },
+    "BRD": { "short": "詩", "role": "dps" },
+    "BLM": { "short": "黒", "role": "dps" },
+    "SMN": { "short": "召", "role": "dps" },
+    "RDM": { "short": "赤", "role": "dps" },
+    "PCT": { "short": "ピ", "role": "dps" }
+  }
+}

package/dist/cli.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const cliOptions_1 = require("./cliOptions");
+const envOptions_1 = require("./envOptions");
+const runApp_1 = require("./runApp");
+/**
+ * パイプ出力時（例: `| head`）の EPIPE を無視するハンドラを登録します。
+ */
+function installStdoutEpipeHandler() {
+    process.stdout.on("error", (err) => {
+        if (err.code === "EPIPE")
+            process.exit(0);
+        throw err;
+    });
+}
+/**
+ * CLI エントリポイント。
+ *
+ * Lambda と同じ `runApp` を呼び出して実行します。
+ */
+async function main() {
+    installStdoutEpipeHandler();
+    const cliOptions = (0, cliOptions_1.parseCliArgs)(process.argv.slice(2));
+    const envOptions = (0, envOptions_1.readEnvOptions)();
+    const options = (0, envOptions_1.resolveOptions)(cliOptions, envOptions);
+    await (0, runApp_1.runApp)(options);
+}
+/**
+ * トップレベルのエラーハンドラ（スタック/メッセージ出力 + 非0終了コード）。
+ */
+main().catch((err) => {
+    const message = err instanceof Error ? err.stack ?? err.message : String(err);
+    process.stderr.write(message + "\n");
+    process.exitCode = 1;
+});

package/dist/cliOptions.js

@@ -0,0 +1,68 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.printUsageAndExit = printUsageAndExit;
+exports.getUsageText = getUsageText;
+exports.parseCliArgs = parseCliArgs;
+const config_1 = require("./config");
+/**
+ * Usage を stderr に出力して終了します。
+ */
+function printUsageAndExit(exitCode = 0) {
+    process.stderr.write(getUsageText() + "\n");
+    process.exit(exitCode);
+}
+/**
+ * Usage 文字列を生成します（テストしやすいように純粋関数にしています）。
+ */
+function getUsageText() {
+    return [
+        "Usage:",
+        `  yarn start -- [--limit <n>] [--discord]`,
+        `    defaults: --limit ${config_1.DEFAULT_WEBHOOK_LIMIT}`,
+        "",
+        "Environment variables (Lambda-friendly):",
+        `  ${config_1.ENV.LIMIT}=<n>  (default: ${config_1.DEFAULT_WEBHOOK_LIMIT})`,
+        `  ${config_1.ENV.DISCORD_WEBHOOK_URL}=<discord_webhook_url>  (required)`,
+        `  ${config_1.ENV.FILTER_FILE}=<path>  (default: data/filter.json)`,
+        "Examples:",
+        `  ${config_1.ENV.DISCORD_WEBHOOK_URL}=\"https://discord.com/api/webhooks/...\" yarn notify`,
+        `  ${config_1.ENV.LIMIT}=5 ${config_1.ENV.DISCORD_WEBHOOK_URL}=\"https://discord.com/api/webhooks/...\" yarn notify`,
+        `  yarn start -- --discord --limit 5`
+    ].join("\n");
+}
+/**
+ * CLI 引数（argv）をオプションにパースします。
+ * ここでは argv の解析のみ行い、環境変数とのマージやデフォルト適用は別モジュールで行います。
+ */
+function parseCliArgs(argv) {
+    const options = {};
+    for (let index = 0; index < argv.length; index++) {
+        const arg = argv[index];
+        if (arg === "--help" || arg === "-h") {
+            printUsageAndExit(0);
+        }
+        if (arg === "--query" || arg === "-q") {
+            options.query = argv[++index];
+            continue;
+        }
+        if (arg === "--discord") {
+            options.output = "discord";
+            continue;
+        }
+        if (arg === "--limit" || arg === "-l") {
+            const raw = argv[++index];
+            const parsed = Number(raw);
+            if (!Number.isFinite(parsed) || parsed <= 0) {
+                process.stderr.write(`Invalid --limit: ${raw}\n`);
+                process.exit(2);
+            }
+            options.limit = Math.floor(parsed);
+            continue;
+        }
+        if (!options.query) {
+            options.query = arg;
+            continue;
+        }
+    }
+    return options;
+}

package/dist/config.js

@@ -0,0 +1,16 @@
+"use strict";
+/**
+ * CLI 全体で共有するデフォルト値・設定。
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENV = exports.ALLOWED_DATA_CENTRES = exports.DEFAULT_FILTER_FILE = exports.DEFAULT_WEBHOOK_LIMIT = exports.DEFAULT_COOKIE = exports.DEFAULT_LISTINGS_URL = void 0;
+exports.DEFAULT_LISTINGS_URL = "https://xivpf.com/listings";
+exports.DEFAULT_COOKIE = "lang=ja";
+exports.DEFAULT_WEBHOOK_LIMIT = 5;
+exports.DEFAULT_FILTER_FILE = "data/filter.json";
+exports.ALLOWED_DATA_CENTRES = new Set(["Elemental", "Mana", "Meteor", "Gaia"]);
+exports.ENV = {
+    LIMIT: "FFXIV_PTFINDER_LIMIT",
+    DISCORD_WEBHOOK_URL: "DISCORD_WEBHOOK_URL",
+    FILTER_FILE: "FFXIV_PTFINDER_FILTER_FILE"
+};

package/dist/debugCli.js

@@ -0,0 +1,101 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const config_1 = require("./config");
+const cliOptions_1 = require("./cliOptions");
+const envOptions_1 = require("./envOptions");
+const jobs_1 = require("./jobs");
+const listingsPipeline_1 = require("./listingsPipeline");
+const discordWebhook_1 = require("./discordWebhook");
+const partyText_1 = require("./partyText");
+const jobMaps_1 = require("./jobMaps");
+const lodestoneEnrichment_1 = require("./lodestoneEnrichment");
+const searchFilter_1 = require("./searchFilter");
+/**
+ * パイプ出力時（例: `| head`）の EPIPE を無視するハンドラを登録します。
+ */
+function installStdoutEpipeHandler() {
+    process.stdout.on("error", (err) => {
+        if (err.code === "EPIPE")
+            process.exit(0);
+        throw err;
+    });
+}
+/**
+ * デバッグ用エントリポイント。
+ *
+ * - Webhook 送信はせず、募集一覧を JSON で標準出力に吐き出します。
+ * - 入力は固定で `https://xivpf.com/listings` を使用します。
+ */
+async function main() {
+    installStdoutEpipeHandler();
+    const cli = (0, cliOptions_1.parseCliArgs)(process.argv.slice(2));
+    const env = (0, envOptions_1.readEnvOptions)();
+    const filterFile = env.filterFile ?? config_1.DEFAULT_FILTER_FILE;
+    const searchFilter = await (0, searchFilter_1.loadListingSearchFilterFromFile)(filterFile);
+    const preFiltered = await (0, listingsPipeline_1.buildListings)({
+        input: config_1.DEFAULT_LISTINGS_URL,
+        searchFilter
+    });
+    const limit = cli.limit ?? env.limit;
+    const jobsJa = await (0, jobs_1.loadJobsJa)();
+    const { codeToShort, codeToRole } = (0, jobMaps_1.buildJobMaps)(jobsJa.jobs);
+    const listings = await applyFullFilter({
+        listings: preFiltered,
+        searchFilter,
+        limit,
+        codeToShort,
+        codeToRole,
+        enrichLodestone: cli.output === "discord" || Boolean(searchFilter?.achievements)
+    });
+    if (cli.output === "discord") {
+        process.stdout.write(formatDiscordPreview(listings, codeToShort, codeToRole) + "\n");
+        return;
+    }
+    process.stdout.write(JSON.stringify(listings, null, 2) + "\n");
+}
+/**
+ * `filter.json` の内容をできるだけ実運用（Lambda）に近い形で評価します。
+ *
+ * - party/formattedText はここで評価します（`buildListings` の事前フィルタには含まれないため）
+ * - achievements 指定がある場合は、Lodestoneアクセスを行い達成状況を補完します
+ */
+async function applyFullFilter(params) {
+    const hasSearchFilter = Boolean(params.searchFilter);
+    if (!hasSearchFilter)
+        return params.limit ? params.listings.slice(0, params.limit) : params.listings;
+    const lodestoneCache = params.enrichLodestone ? (0, lodestoneEnrichment_1.createLodestoneEnrichmentCache)() : undefined;
+    const matched = [];
+    for (const listing of params.listings) {
+        const enriched = params.enrichLodestone && lodestoneCache
+            ? await (0, lodestoneEnrichment_1.enrichListingWithLodestone)(listing, lodestoneCache)
+            : listing;
+        const formattedText = (0, partyText_1.formatListingText)(enriched, params.codeToShort, params.codeToRole);
+        const ok = await (0, searchFilter_1.matchListing)({
+            listing: enriched,
+            filter: params.searchFilter,
+            formattedText
+        });
+        if (!ok)
+            continue;
+        matched.push(enriched);
+        if (params.limit && matched.length >= params.limit)
+            break;
+    }
+    return matched;
+}
+/**
+ * Webhook送信の本文と同じ形式（コードブロック）で標準出力に出します。
+ *
+ * - 1募集=1メッセージ想定なので、募集ごとにコードブロックを出します
+ * - ヒット0件の場合は、Webhookで送る文言と同じ文言を出します
+ */
+function formatDiscordPreview(listings, codeToShort, codeToRole) {
+    if (listings.length === 0)
+        return "該当の募集は見つかりませんでした";
+    return listings.map((l) => (0, discordWebhook_1.toDiscordCodeBlock)((0, partyText_1.formatListingText)(l, codeToShort, codeToRole))).join("\n\n");
+}
+main().catch((err) => {
+    const message = err instanceof Error ? err.stack ?? err.message : String(err);
+    process.stderr.write(message + "\n");
+    process.exitCode = 1;
+});

package/dist/descriptionRequirements.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeSpaces = normalizeSpaces;
+exports.applyDescriptionTags = applyDescriptionTags;
+/**
+ * 表示用に空白を正規化します。
+ */
+function normalizeSpaces(value) {
+    return value.replace(/\s+/g, " ").trim();
+}
+/**
+ * description からタグ（例: `[Practice]`）を検出してラベルを抽出し、
+ * 本文からタグトークンを除去します。
+ *
+ * `Listing.description` を読みやすく保ち、タグの意味は `Listing.requirements` に移します。
+ */
+function applyDescriptionTags(listings, tags) {
+    return listings.map((listing) => {
+        const requirements = new Set();
+        let description = listing.description;
+        for (const tag of tags) {
+            if (!tag.token)
+                continue;
+            if (description.includes(tag.token))
+                requirements.add(tag.label);
+            description = description.split(tag.token).join("");
+        }
+        return {
+            ...listing,
+            requirements: Array.from(requirements),
+            description: normalizeSpaces(description)
+        };
+    });
+}

package/dist/descriptionTags.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadDescriptionTagsJa = loadDescriptionTagsJa;
+const promises_1 = require("node:fs/promises");
+const node_path_1 = require("node:path");
+let cachedTags;
+/**
+ * `data/description_tags_ja.json` を読み込みます（初回のみ読み取り、以後はキャッシュ）。
+ */
+async function loadDescriptionTagsJa() {
+    if (cachedTags)
+        return cachedTags;
+    const filePath = (0, node_path_1.resolve)(process.cwd(), "data/description_tags_ja.json");
+    const raw = await (0, promises_1.readFile)(filePath, "utf8");
+    cachedTags = JSON.parse(raw);
+    return cachedTags;
+}

package/dist/discordWebhook.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sleep = sleep;
+exports.toDiscordCodeBlock = toDiscordCodeBlock;
+exports.postDiscordWebhook = postDiscordWebhook;
+const axios_1 = __importDefault(require("axios"));
+/**
+ * 指定ミリ秒だけ待機します。
+ */
+async function sleep(ms) {
+    await new Promise((resolve) => setTimeout(resolve, ms));
+}
+/**
+ * Discord のコードブロック形式に変換し、2000文字制限に引っかからないように切り詰めます。
+ */
+function toDiscordCodeBlock(text, maxChars = 1900) {
+    const sanitized = text.replace(/```/g, "'''").trim();
+    const truncated = sanitized.length > maxChars ? sanitized.slice(0, maxChars - 1).trimEnd() + "…" : sanitized;
+    return "```\n" + truncated + "\n```";
+}
+async function sendWebhook(webhookUrl, content) {
+    await axios_1.default.post(webhookUrl, { content }, {
+        headers: { "Content-Type": "application/json" },
+        timeout: 30000
+    });
+}
+/**
+ * Discord Webhook に送信します（レート制限: HTTP 429 の場合は 1 回だけリトライします）。
+ */
+async function postDiscordWebhook(webhookUrl, content) {
+    try {
+        await sendWebhook(webhookUrl, content);
+        return;
+    }
+    catch (err) {
+        if (!axios_1.default.isAxiosError(err))
+            throw err;
+        if (err.response?.status !== 429)
+            throw err;
+        const retryAfterMs = typeof err.response.data?.retry_after === "number"
+            ? Math.ceil(err.response.data.retry_after * 1000)
+            : 1500;
+        await sleep(retryAfterMs);
+        await sendWebhook(webhookUrl, content);
+    }
+}

package/dist/envOptions.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getEnvString = getEnvString;
+exports.parsePositiveInt = parsePositiveInt;
+exports.readEnvOptions = readEnvOptions;
+exports.resolveOptions = resolveOptions;
+const config_1 = require("./config");
+/**
+ * 環境変数を読み取り、前後空白を除いた文字列を返します（空なら undefined）。
+ */
+function getEnvString(name) {
+    const value = process.env[name];
+    const trimmed = typeof value === "string" ? value.trim() : "";
+    return trimmed.length > 0 ? trimmed : undefined;
+}
+/**
+ * 正の整数として解釈できる場合のみ数値を返します。
+ */
+function parsePositiveInt(value) {
+    if (!value)
+        return undefined;
+    const parsed = Number(value);
+    if (!Number.isFinite(parsed) || parsed <= 0)
+        return undefined;
+    return Math.floor(parsed);
+}
+/**
+ * 環境変数からオプションを読み取ります（デフォルト値はここでは適用しません）。
+ */
+function readEnvOptions() {
+    return {
+        limit: parsePositiveInt(getEnvString(config_1.ENV.LIMIT)),
+        filterFile: getEnvString(config_1.ENV.FILTER_FILE)
+    };
+}
+/**
+ * CLIオプションを優先して環境変数オプションとマージし、デフォルト値を適用します。
+ */
+function resolveOptions(cli, env) {
+    const webhookUrl = getEnvString(config_1.ENV.DISCORD_WEBHOOK_URL);
+    if (!webhookUrl) {
+        throw new Error(`${config_1.ENV.DISCORD_WEBHOOK_URL} is required.`);
+    }
+    const searchFilterFile = env.filterFile ?? config_1.DEFAULT_FILTER_FILE;
+    return {
+        input: config_1.DEFAULT_LISTINGS_URL,
+        webhookUrl,
+        limit: cli.limit ?? env.limit ?? config_1.DEFAULT_WEBHOOK_LIMIT,
+        searchFilter: undefined,
+        searchFilterFile
+    };
+}