@rmdes/indiekit-endpoint-activitypub 2.15.4 → 3.2.0

package/lib/mastodon/routes/instance.js

@@ -0,0 +1,207 @@
+/**
+ * Instance info endpoints for Mastodon Client API.
+ *
+ * GET /api/v2/instance — v2 format (primary)
+ * GET /api/v1/instance — v1 format (fallback for older clients)
+ */
+import express from "express";
+import { serializeAccount } from "../entities/account.js";
+
+const router = express.Router(); // eslint-disable-line new-cap
+
+// ─── GET /api/v2/instance ────────────────────────────────────────────────────
+
+router.get("/api/v2/instance", async (req, res, next) => {
+  try {
+    const baseUrl = `${req.protocol}://${req.get("host")}`;
+    const domain = req.get("host");
+    const collections = req.app.locals.mastodonCollections;
+    const pluginOptions = req.app.locals.mastodonPluginOptions || {};
+
+    const profile = await collections.ap_profile.findOne({});
+    const contactAccount = profile
+      ? serializeAccount(profile, {
+          baseUrl,
+          isLocal: true,
+          handle: pluginOptions.handle || "user",
+        })
+      : null;
+
+    res.json({
+      domain,
+      title: profile?.name || domain,
+      version: "4.0.0 (compatible; Indiekit ActivityPub)",
+      source_url: "https://github.com/getindiekit/indiekit",
+      description: profile?.summary || `An Indiekit instance at ${domain}`,
+      usage: {
+        users: {
+          active_month: 1,
+        },
+      },
+      thumbnail: {
+        url: profile?.icon || `${baseUrl}/favicon.ico`,
+        blurhash: null,
+        versions: {},
+      },
+      icon: [],
+      languages: ["en"],
+      configuration: {
+        urls: {
+          streaming: "",
+        },
+        accounts: {
+          max_featured_tags: 10,
+          max_pinned_statuses: 10,
+        },
+        statuses: {
+          max_characters: 5000,
+          max_media_attachments: 4,
+          characters_reserved_per_url: 23,
+        },
+        media_attachments: {
+          supported_mime_types: [
+            "image/jpeg",
+            "image/png",
+            "image/gif",
+            "image/webp",
+            "video/mp4",
+            "video/webm",
+            "audio/mpeg",
+            "audio/ogg",
+          ],
+          image_size_limit: 16_777_216,
+          image_matrix_limit: 16_777_216,
+          video_size_limit: 67_108_864,
+          video_frame_rate_limit: 60,
+          video_matrix_limit: 16_777_216,
+        },
+        polls: {
+          max_options: 4,
+          max_characters_per_option: 50,
+          min_expiration: 300,
+          max_expiration: 2_592_000,
+        },
+        translation: {
+          enabled: false,
+        },
+        vapid: {
+          public_key: "",
+        },
+      },
+      registrations: {
+        enabled: false,
+        approval_required: true,
+        message: null,
+        url: null,
+      },
+      api_versions: {
+        mastodon: 0,
+      },
+      contact: {
+        email: "",
+        account: contactAccount,
+      },
+      rules: [],
+    });
+  } catch (error) {
+    next(error);
+  }
+});
+
+// ─── GET /api/v1/instance ────────────────────────────────────────────────────
+
+router.get("/api/v1/instance", async (req, res, next) => {
+  try {
+    const baseUrl = `${req.protocol}://${req.get("host")}`;
+    const domain = req.get("host");
+    const collections = req.app.locals.mastodonCollections;
+    const pluginOptions = req.app.locals.mastodonPluginOptions || {};
+
+    const profile = await collections.ap_profile.findOne({});
+
+    // Get approximate counts
+    let statusCount = 0;
+    let domainCount = 0;
+    try {
+      statusCount = await collections.ap_timeline.countDocuments({});
+      // Rough domain count from unique follower domains
+      const followers = await collections.ap_followers
+        .find({}, { projection: { actorUrl: 1 } })
+        .toArray();
+      const domains = new Set(
+        followers
+          .map((f) => {
+            try {
+              return new URL(f.actorUrl).hostname;
+            } catch {
+              return null;
+            }
+          })
+          .filter(Boolean),
+      );
+      domainCount = domains.size;
+    } catch {
+      // Non-critical
+    }
+
+    res.json({
+      uri: domain,
+      title: profile?.name || domain,
+      short_description: profile?.summary || "",
+      description: profile?.summary || `An Indiekit instance at ${domain}`,
+      email: "",
+      version: "4.0.0 (compatible; Indiekit ActivityPub)",
+      urls: {
+        streaming_api: "",
+      },
+      stats: {
+        user_count: 1,
+        status_count: statusCount,
+        domain_count: domainCount,
+      },
+      thumbnail: profile?.icon || null,
+      languages: ["en"],
+      registrations: false,
+      approval_required: true,
+      invites_enabled: false,
+      configuration: {
+        statuses: {
+          max_characters: 5000,
+          max_media_attachments: 4,
+          characters_reserved_per_url: 23,
+        },
+        media_attachments: {
+          supported_mime_types: [
+            "image/jpeg",
+            "image/png",
+            "image/gif",
+            "image/webp",
+          ],
+          image_size_limit: 16_777_216,
+          image_matrix_limit: 16_777_216,
+          video_size_limit: 67_108_864,
+          video_frame_rate_limit: 60,
+          video_matrix_limit: 16_777_216,
+        },
+        polls: {
+          max_options: 4,
+          max_characters_per_option: 50,
+          min_expiration: 300,
+          max_expiration: 2_592_000,
+        },
+      },
+      contact_account: profile
+        ? serializeAccount(profile, {
+            baseUrl,
+            isLocal: true,
+            handle: pluginOptions.handle || "user",
+          })
+        : null,
+      rules: [],
+    });
+  } catch (error) {
+    next(error);
+  }
+});
+
+export default router;

package/lib/mastodon/routes/media.js

@@ -0,0 +1,43 @@
+/**
+ * Media endpoints for Mastodon Client API.
+ *
+ * POST /api/v2/media — upload media attachment (stub — returns 422 until storage is configured)
+ * POST /api/v1/media — legacy upload endpoint (redirects to v2)
+ * GET /api/v1/media/:id — get media attachment status
+ * PUT /api/v1/media/:id — update media metadata (description/focus)
+ */
+import express from "express";
+
+const router = express.Router(); // eslint-disable-line new-cap
+
+// ─── POST /api/v2/media ─────────────────────────────────────────────────────
+
+router.post("/api/v2/media", (req, res) => {
+  // Media upload requires multer/multipart handling + storage backend.
+  // For now, return 422 so clients show a user-friendly error.
+  res.status(422).json({
+    error: "Media uploads are not yet supported on this server",
+  });
+});
+
+// ─── POST /api/v1/media (legacy) ────────────────────────────────────────────
+
+router.post("/api/v1/media", (req, res) => {
+  res.status(422).json({
+    error: "Media uploads are not yet supported on this server",
+  });
+});
+
+// ─── GET /api/v1/media/:id ──────────────────────────────────────────────────
+
+router.get("/api/v1/media/:id", (req, res) => {
+  res.status(404).json({ error: "Record not found" });
+});
+
+// ─── PUT /api/v1/media/:id ──────────────────────────────────────────────────
+
+router.put("/api/v1/media/:id", (req, res) => {
+  res.status(404).json({ error: "Record not found" });
+});
+
+export default router;

package/lib/mastodon/routes/notifications.js

@@ -0,0 +1,257 @@
+/**
+ * Notification endpoints for Mastodon Client API.
+ *
+ * GET /api/v1/notifications — list notifications with pagination
+ * GET /api/v1/notifications/:id — single notification
+ * POST /api/v1/notifications/clear — clear all notifications
+ * POST /api/v1/notifications/:id/dismiss — dismiss single notification
+ */
+import express from "express";
+import { ObjectId } from "mongodb";
+import { serializeNotification } from "../entities/notification.js";
+import { buildPaginationQuery, parseLimit, setPaginationHeaders } from "../helpers/pagination.js";
+
+const router = express.Router(); // eslint-disable-line new-cap
+
+/**
+ * Mastodon type -> internal type reverse mapping for filtering.
+ */
+const REVERSE_TYPE_MAP = {
+  favourite: "like",
+  reblog: "boost",
+  follow: "follow",
+  follow_request: "follow_request",
+  mention: { $in: ["reply", "mention", "dm"] },
+  poll: "poll",
+  update: "update",
+  "admin.report": "report",
+};
+
+// ─── GET /api/v1/notifications ──────────────────────────────────────────────
+
+router.get("/api/v1/notifications", async (req, res, next) => {
+  try {
+    const token = req.mastodonToken;
+    if (!token) {
+      return res.status(401).json({ error: "The access token is invalid" });
+    }
+
+    const collections = req.app.locals.mastodonCollections;
+    const baseUrl = `${req.protocol}://${req.get("host")}`;
+    const limit = parseLimit(req.query.limit);
+
+    // Build base filter
+    const baseFilter = {};
+
+    // types[] — include only these Mastodon types
+    const includeTypes = normalizeArray(req.query["types[]"] || req.query.types);
+    if (includeTypes.length > 0) {
+      const internalTypes = resolveInternalTypes(includeTypes);
+      if (internalTypes.length > 0) {
+        baseFilter.type = { $in: internalTypes };
+      }
+    }
+
+    // exclude_types[] — exclude these Mastodon types
+    const excludeTypes = normalizeArray(req.query["exclude_types[]"] || req.query.exclude_types);
+    if (excludeTypes.length > 0) {
+      const excludeInternal = resolveInternalTypes(excludeTypes);
+      if (excludeInternal.length > 0) {
+        baseFilter.type = { ...baseFilter.type, $nin: excludeInternal };
+      }
+    }
+
+    // Apply cursor pagination
+    const { filter, sort, reverse } = buildPaginationQuery(baseFilter, {
+      max_id: req.query.max_id,
+      min_id: req.query.min_id,
+      since_id: req.query.since_id,
+    });
+
+    let items = await collections.ap_notifications
+      .find(filter)
+      .sort(sort)
+      .limit(limit)
+      .toArray();
+
+    if (reverse) {
+      items.reverse();
+    }
+
+    // Batch-fetch referenced timeline items to avoid N+1
+    const statusMap = await batchFetchStatuses(collections, items);
+
+    // Serialize notifications
+    const notifications = items.map((notif) =>
+      serializeNotification(notif, {
+        baseUrl,
+        statusMap,
+        interactionState: {
+          favouritedIds: new Set(),
+          rebloggedIds: new Set(),
+          bookmarkedIds: new Set(),
+        },
+      }),
+    ).filter(Boolean);
+
+    // Set pagination headers
+    setPaginationHeaders(res, req, items, limit);
+
+    res.json(notifications);
+  } catch (error) {
+    next(error);
+  }
+});
+
+// ─── GET /api/v1/notifications/:id ──────────────────────────────────────────
+
+router.get("/api/v1/notifications/:id", async (req, res, next) => {
+  try {
+    const token = req.mastodonToken;
+    if (!token) {
+      return res.status(401).json({ error: "The access token is invalid" });
+    }
+
+    const collections = req.app.locals.mastodonCollections;
+    const baseUrl = `${req.protocol}://${req.get("host")}`;
+
+    let objectId;
+    try {
+      objectId = new ObjectId(req.params.id);
+    } catch {
+      return res.status(404).json({ error: "Record not found" });
+    }
+
+    const notif = await collections.ap_notifications.findOne({ _id: objectId });
+    if (!notif) {
+      return res.status(404).json({ error: "Record not found" });
+    }
+
+    const statusMap = await batchFetchStatuses(collections, [notif]);
+
+    const notification = serializeNotification(notif, {
+      baseUrl,
+      statusMap,
+      interactionState: {
+        favouritedIds: new Set(),
+        rebloggedIds: new Set(),
+        bookmarkedIds: new Set(),
+      },
+    });
+
+    res.json(notification);
+  } catch (error) {
+    next(error);
+  }
+});
+
+// ─── POST /api/v1/notifications/clear ───────────────────────────────────────
+
+router.post("/api/v1/notifications/clear", async (req, res, next) => {
+  try {
+    const token = req.mastodonToken;
+    if (!token) {
+      return res.status(401).json({ error: "The access token is invalid" });
+    }
+
+    const collections = req.app.locals.mastodonCollections;
+    await collections.ap_notifications.deleteMany({});
+    res.json({});
+  } catch (error) {
+    next(error);
+  }
+});
+
+// ─── POST /api/v1/notifications/:id/dismiss ─────────────────────────────────
+
+router.post("/api/v1/notifications/:id/dismiss", async (req, res, next) => {
+  try {
+    const token = req.mastodonToken;
+    if (!token) {
+      return res.status(401).json({ error: "The access token is invalid" });
+    }
+
+    const collections = req.app.locals.mastodonCollections;
+
+    let objectId;
+    try {
+      objectId = new ObjectId(req.params.id);
+    } catch {
+      return res.status(404).json({ error: "Record not found" });
+    }
+
+    await collections.ap_notifications.deleteOne({ _id: objectId });
+    res.json({});
+  } catch (error) {
+    next(error);
+  }
+});
+
+// ─── Helpers ─────────────────────────────────────────────────────────────────
+
+/**
+ * Normalize query param to array (handles string or array).
+ */
+function normalizeArray(param) {
+  if (!param) return [];
+  return Array.isArray(param) ? param : [param];
+}
+
+/**
+ * Convert Mastodon notification types to internal types.
+ */
+function resolveInternalTypes(mastodonTypes) {
+  const result = [];
+  for (const t of mastodonTypes) {
+    const mapped = REVERSE_TYPE_MAP[t];
+    if (mapped) {
+      if (mapped.$in) {
+        result.push(...mapped.$in);
+      } else {
+        result.push(mapped);
+      }
+    }
+  }
+  return result;
+}
+
+/**
+ * Batch-fetch timeline items referenced by notifications.
+ *
+ * @param {object} collections
+ * @param {Array} notifications
+ * @returns {Promise<Map<string, object>>} Map of targetUrl -> timeline item
+ */
+async function batchFetchStatuses(collections, notifications) {
+  const statusMap = new Map();
+
+  const targetUrls = [
+    ...new Set(
+      notifications
+        .map((n) => n.targetUrl)
+        .filter(Boolean),
+    ),
+  ];
+
+  if (targetUrls.length === 0 || !collections.ap_timeline) {
+    return statusMap;
+  }
+
+  const items = await collections.ap_timeline
+    .find({
+      $or: [
+        { uid: { $in: targetUrls } },
+        { url: { $in: targetUrls } },
+      ],
+    })
+    .toArray();
+
+  for (const item of items) {
+    if (item.uid) statusMap.set(item.uid, item);
+    if (item.url) statusMap.set(item.url, item);
+  }
+
+  return statusMap;
+}
+
+export default router;