@rmdes/indiekit-endpoint-microsub 1.0.9 → 1.0.10

package/lib/controllers/reader.js

@@ -21,6 +21,7 @@ import {
   getTimelineItems,
   getItemById,
   markItemsRead,
+  countReadItems,
 } from "../storage/items.js";
 import { getUserId } from "../utils/auth.js";
 import {
@@ -95,24 +96,37 @@ export async function channel(request, response) {
   const { application } = request.app.locals;
   const userId = getUserId(request);
   const { uid } = request.params;
-  const { before, after } = request.query;
+  const { before, after, showRead } = request.query;
 
   const channelDocument = await getChannel(application, uid, userId);
   if (!channelDocument) {
     return response.status(404).render("404");
   }
 
+  // Check if showing read items
+  const showReadItems = showRead === "true";
+
   const timeline = await getTimelineItems(application, channelDocument._id, {
     before,
     after,
     userId,
+    showRead: showReadItems,
   });
 
+  // Count read items to show "View read items" button
+  const readCount = await countReadItems(
+    application,
+    channelDocument._id,
+    userId,
+  );
+
   response.render("channel", {
     title: channelDocument.name,
     channel: channelDocument,
     items: timeline.items,
     paging: timeline.paging,
+    readCount,
+    showRead: showReadItems,
     baseUrl: request.baseUrl,
   });
 }

package/lib/storage/items.js

@@ -78,6 +78,7 @@ export async function addItem(application, { channelId, feedId, uid, item }) {
  * @param {string} [options.after] - After cursor
  * @param {number} [options.limit] - Items per page
  * @param {string} [options.userId] - User ID for read state
+ * @param {boolean} [options.showRead] - Whether to show read items (default: false)
  * @returns {Promise<object>} Timeline with items and paging
  */
 export async function getTimelineItems(application, channelId, options = {}) {
@@ -86,7 +87,12 @@ export async function getTimelineItems(application, channelId, options = {}) {
     typeof channelId === "string" ? new ObjectId(channelId) : channelId;
   const limit = parseLimit(options.limit);
 
+  // Base query - filter out read items unless showRead is true
   const baseQuery = { channelId: objectId };
+  if (options.userId && !options.showRead) {
+    baseQuery.readBy = { $ne: options.userId };
+  }
+
   const query = buildPaginationQuery({
     before: options.before,
     after: options.after,
@@ -256,6 +262,24 @@ export async function getItemsByUids(application, uids, userId) {
   return items.map((item) => transformToJf2(item, userId));
 }
 
+/**
+ * Count read items in a channel for a user
+ * @param {object} application - Indiekit application
+ * @param {ObjectId|string} channelId - Channel ObjectId
+ * @param {string} userId - User ID
+ * @returns {Promise<number>} Count of read items
+ */
+export async function countReadItems(application, channelId, userId) {
+  const collection = getCollection(application);
+  const objectId =
+    typeof channelId === "string" ? new ObjectId(channelId) : channelId;
+
+  return collection.countDocuments({
+    channelId: objectId,
+    readBy: userId,
+  });
+}
+
 /**
  * Mark items as read
  * @param {object} application - Indiekit application

package/locales/en.json

@@ -4,6 +4,9 @@
       "title": "Reader",
       "empty": "No items to display",
       "markAllRead": "Mark all as read",
+      "showRead": "Show read ({{count}})",
+      "hideRead": "Hide read items",
+      "allRead": "All caught up!",
       "newer": "Newer",
       "older": "Older"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rmdes/indiekit-endpoint-microsub",
-  "version": "1.0.9",
+  "version": "1.0.10",
   "description": "Microsub endpoint for Indiekit. Enables subscribing to feeds and reading content using the Microsub protocol.",
   "keywords": [
     "indiekit",

package/views/channel.njk

@@ -7,6 +7,7 @@
         {{ icon("previous") }} {{ __("microsub.channels.title") }}
       </a>
       <div class="channel__actions">
+        {% if not showRead and items.length > 0 %}
         <form action="{{ baseUrl }}/api/mark-read" method="POST" style="display: inline;">
           <input type="hidden" name="channel" value="{{ channel.uid }}">
           <input type="hidden" name="entry" value="last-read-entry">
@@ -14,6 +15,16 @@
             {{ icon("checkboxChecked") }} {{ __("microsub.reader.markAllRead") }}
           </button>
         </form>
+        {% endif %}
+        {% if showRead %}
+        <a href="{{ baseUrl }}/channels/{{ channel.uid }}" class="button button--secondary button--small">
+          {{ icon("hide") }} {{ __("microsub.reader.hideRead") }}
+        </a>
+        {% elif readCount > 0 %}
+        <a href="{{ baseUrl }}/channels/{{ channel.uid }}?showRead=true" class="button button--secondary button--small">
+          {{ icon("show") }} {{ __("microsub.reader.showRead", { count: readCount }) }}
+        </a>
+        {% endif %}
         <a href="{{ baseUrl }}/channels/{{ channel.uid }}/feeds" class="button button--secondary button--small">
           {{ icon("syndicate") }} {{ __("microsub.feeds.title") }}
         </a>
@@ -48,11 +59,19 @@
     {% endif %}
     {% else %}
     <div class="reader__empty">
+      {% if readCount > 0 and not showRead %}
+      {{ icon("checkboxChecked") }}
+      <p>{{ __("microsub.reader.allRead") }}</p>
+      <a href="{{ baseUrl }}/channels/{{ channel.uid }}?showRead=true" class="button button--secondary">
+        {{ icon("show") }} {{ __("microsub.reader.showRead", { count: readCount }) }}
+      </a>
+      {% else %}
       {{ icon("syndicate") }}
       <p>{{ __("microsub.timeline.empty") }}</p>
       <a href="{{ baseUrl }}/channels/{{ channel.uid }}/feeds" class="button button--primary">
         {{ __("microsub.feeds.subscribe") }}
       </a>
+      {% endif %}
     </div>
     {% endif %}
   </div>