@fedify/fedify 0.11.0-dev.240 → 0.11.0-dev.241

package/CHANGES.md

@@ -21,6 +21,10 @@ To be released.
      -  Added `{ type: "liked"; handle: string }` case to `ParseUriResult` type.
      -  Renamed `linked` property (which was a typo) to `liked` in
         `Application`, `Group`, `Organization`, `Person`, and `Service` classes.
+     -  Added `Federation.setFeaturedDispatcher()` method.
+     -  Added `Context.getFeaturedUri()` method.
+     -  Added `{ type: "featured"; handle: string }` case to `ParseUriResult`
+        type.
 
  -  Frequently used JSON-LD contexts are now preloaded.  [[74]]
 

package/esm/federation/middleware.js

@@ -48,6 +48,7 @@ export class Federation {
     #followingCallbacks;
     #followersCallbacks;
     #likedCallbacks;
+    #featuredCallbacks;
     #inboxListeners;
     #inboxErrorHandler;
     #sharedInboxKeyDispatcher;
@@ -334,6 +335,19 @@ export class Federation {
                             "URI.  Set the property with Context.getLikedUri(handle).");
                     }
                 }
+                if (this.#featuredCallbacks != null &&
+                    this.#featuredCallbacks.dispatcher != null) {
+                    if (actor?.featuredId == null) {
+                        logger.warn("You configured a featured collection dispatcher, but the " +
+                            "actor does not have a featured property.  Set the property " +
+                            "with Context.getFeaturedUri(handle).");
+                    }
+                    else if (actor.featuredId.href != context.getFeaturedUri(handle).href) {
+                        logger.warn("You configured a featured collection dispatcher, but the " +
+                            "actor's featured property does not match the featured collection " +
+                            "URI.  Set the property with Context.getFeaturedUri(handle).");
+                    }
+                }
                 if (this.#router.has("inbox")) {
                     if (actor.inboxId == null) {
                         logger.warn("You configured inbox listeners, but the actor does not " +
@@ -658,6 +672,50 @@ export class Federation {
         };
         return setters;
     }
+    /**
+     * Registers a featured collection dispatcher.
+     * @param path The URI path pattern for the featured collection.  The syntax
+     *             is based on URI Template
+     *             ([RFC 6570](https://tools.ietf.org/html/rfc6570)).  The path
+     *             must have one variable: `{handle}`.
+     * @param dispatcher A featured collection callback to register.
+     * @returns An object with methods to set other featured collection
+     *          callbacks.
+     * @throws {@link RouterError} Thrown if the path pattern is invalid.
+     * @since 0.11.0
+     */
+    setFeaturedDispatcher(path, dispatcher) {
+        if (this.#router.has("featured")) {
+            throw new RouterError("Featured collection dispatcher already set.");
+        }
+        const variables = this.#router.add(path, "featured");
+        if (variables.size !== 1 || !variables.has("handle")) {
+            throw new RouterError("Path for featured collection dispatcher must have one variable: {handle}");
+        }
+        const callbacks = {
+            dispatcher,
+        };
+        this.#featuredCallbacks = callbacks;
+        const setters = {
+            setCounter(counter) {
+                callbacks.counter = counter;
+                return setters;
+            },
+            setFirstCursor(cursor) {
+                callbacks.firstCursor = cursor;
+                return setters;
+            },
+            setLastCursor(cursor) {
+                callbacks.lastCursor = cursor;
+                return setters;
+            },
+            authorize(predicate) {
+                callbacks.authorizePredicate = predicate;
+                return setters;
+            },
+        };
+        return setters;
+    }
     /**
      * Assigns the URL path for the inbox and starts setting inbox listeners.
      *
@@ -994,6 +1052,16 @@ export class Federation {
                     onNotFound,
                     onNotAcceptable,
                 });
+            case "featured":
+                return await handleCollection(request, {
+                    name: "featured",
+                    handle: route.values.handle,
+                    context,
+                    collectionCallbacks: this.#featuredCallbacks,
+                    onUnauthorized,
+                    onNotFound,
+                    onNotAcceptable,
+                });
             default: {
                 const response = onNotFound(request);
                 return response instanceof Promise ? await response : response;
@@ -1099,6 +1167,13 @@ class ContextImpl {
         }
         return new URL(path, this.#url);
     }
+    getFeaturedUri(handle) {
+        const path = this.#router.build("featured", { handle });
+        if (path == null) {
+            throw new RouterError("No featured collection path registered.");
+        }
+        return new URL(path, this.#url);
+    }
     parseUri(uri) {
         if (uri.origin !== this.#url.origin)
             return null;
@@ -1135,6 +1210,9 @@ class ContextImpl {
         else if (route.name === "liked") {
             return { type: "liked", handle: route.values.handle };
         }
+        else if (route.name === "featured") {
+            return { type: "featured", handle: route.values.handle };
+        }
         return null;
     }
     getHandleFromActorUri(actorUri) {

package/esm/vocab/application.yaml

@@ -12,6 +12,9 @@ defaultContext:
 - "https://w3id.org/security/multikey/v1"
 - manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   toot: "http://joinmastodon.org/ns#"
+  featured:
+    "@id": "toot:featured"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -143,6 +146,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featured
+  functional: true
+  uri: "http://joinmastodon.org/ns#featured"
+  description: |
+    What is known in Mastodon as "pinned statuses", or statuses that are always
+    featured at the top of people's profiles, is implemented using an extra
+    property `featured` on the actor object that points to a {@link Collection}
+    of objects.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/esm/vocab/group.yaml

@@ -12,6 +12,9 @@ defaultContext:
 - "https://w3id.org/security/multikey/v1"
 - manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   toot: "http://joinmastodon.org/ns#"
+  featured:
+    "@id": "toot:featured"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -143,6 +146,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featured
+  functional: true
+  uri: "http://joinmastodon.org/ns#featured"
+  description: |
+    What is known in Mastodon as "pinned statuses", or statuses that are always
+    featured at the top of people's profiles, is implemented using an extra
+    property `featured` on the actor object that points to a {@link Collection}
+    of objects.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/esm/vocab/organization.yaml

@@ -12,6 +12,9 @@ defaultContext:
 - "https://w3id.org/security/multikey/v1"
 - manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   toot: "http://joinmastodon.org/ns#"
+  featured:
+    "@id": "toot:featured"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -143,6 +146,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featured
+  functional: true
+  uri: "http://joinmastodon.org/ns#featured"
+  description: |
+    What is known in Mastodon as "pinned statuses", or statuses that are always
+    featured at the top of people's profiles, is implemented using an extra
+    property `featured` on the actor object that points to a {@link Collection}
+    of objects.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/esm/vocab/person.yaml

@@ -12,6 +12,9 @@ defaultContext:
 - "https://w3id.org/security/multikey/v1"
 - manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   toot: "http://joinmastodon.org/ns#"
+  featured:
+    "@id": "toot:featured"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -143,6 +146,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featured
+  functional: true
+  uri: "http://joinmastodon.org/ns#featured"
+  description: |
+    What is known in Mastodon as "pinned statuses", or statuses that are always
+    featured at the top of people's profiles, is implemented using an extra
+    property `featured` on the actor object that points to a {@link Collection}
+    of objects.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/esm/vocab/service.yaml

@@ -12,6 +12,9 @@ defaultContext:
 - "https://w3id.org/security/multikey/v1"
 - manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   toot: "http://joinmastodon.org/ns#"
+  featured:
+    "@id": "toot:featured"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -143,6 +146,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featured
+  functional: true
+  uri: "http://joinmastodon.org/ns#featured"
+  description: |
+    What is known in Mastodon as "pinned statuses", or statuses that are always
+    featured at the top of people's profiles, is implemented using an extra
+    property `featured` on the actor object that points to a {@link Collection}
+    of objects.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false