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

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]]
 
@@ -39,6 +43,53 @@ To be released.
  -  Added `Offer` class to Activity Vocabulary API.
     [[#65], [#76] by Lee Dogeon]
 
+ -  The below properties of `Collection` and `CollectionPage` in Activity
+    Vocabulary API now do not accept `Link` objects:
+
+     -  `Collection.current`
+     -  `Collection.first`
+     -  `Collection.last`
+     -  `Collection.items`
+     -  `CollectionPage.partOf`
+     -  `CollectionPage.next`
+     -  `CollectionPage.prev`
+
+ -  Added `target` property to `Activity` class in Activity Vocabulary API.
+
+     -  Added `Activity.getTarget()` method.
+     -  Added `Activity.getTargets()` method.
+     -  `new Activity()` constructor now accepts `target` option.
+     -  `new Activity()` constructor now accepts `targets` option.
+     -  `Activity.clone()` method now accepts `target` option.
+     -  `Activity.clone()` method now accepts `targets` option.
+
+ -  Added `result` property to `Activity` class in Activity Vocabulary API.
+
+     -  Added `Activity.getResult()` method.
+     -  Added `Activity.getResults()` method.
+     -  `new Activity()` constructor now accepts `result` option.
+     -  `new Activity()` constructor now accepts `results` option.
+     -  `Activity.clone()` method now accepts `result` option.
+     -  `Activity.clone()` method now accepts `results` option.
+
+ -  Added `origin` property to `Activity` class in Activity Vocabulary API.
+
+     -  Added `Activity.getOrigin()` method.
+     -  Added `Activity.getOrigins()` method.
+     -  `new Activity()` constructor now accepts `origin` option.
+     -  `new Activity()` constructor now accepts `origins` option.
+     -  `Activity.clone()` method now accepts `origin` option.
+     -  `Activity.clone()` method now accepts `origins` option.
+
+ -  Added `instrument` property to `Activity` class in Activity Vocabulary API.
+
+     -  Added `Activity.getInstrument()` method.
+     -  Added `Activity.getInstruments()` method.
+     -  `new Activity()` constructor now accepts `instrument` option.
+     -  `new Activity()` constructor now accepts `instruments` option.
+     -  `Activity.clone()` method now accepts `instrument` option.
+     -  `Activity.clone()` method now accepts `instruments` option.
+
  -  The key pair or the key pair for signing outgoing HTTP requests made from
     the shared inbox now can be configured.  This improves the compatibility
     with other ActivityPub implementations that require authorized fetches

package/esm/federation/handler.js

@@ -4,7 +4,7 @@ import { accepts } from "../deps/jsr.io/@std/http/0.224.5/negotiation.js";
 import { verifyRequest } from "../sig/http.js";
 import { doesActorOwnKey } from "../sig/owner.js";
 import { verifyObject } from "../sig/proof.js";
-import { Activity, Link, Object, OrderedCollection, OrderedCollectionPage, } from "../vocab/vocab.js";
+import { Activity, Object, OrderedCollection, OrderedCollectionPage, } from "../vocab/vocab.js";
 export function acceptsJsonLd(request) {
     const types = accepts(request);
     if (types == null)
@@ -146,7 +146,7 @@ function filterCollectionItems(items, collectionName, filterPredicate) {
     let logged = false;
     for (const item of items) {
         let mappedItem;
-        if (item instanceof Object || item instanceof Link || item instanceof URL) {
+        if (item instanceof Object || item instanceof URL) {
             mappedItem = item;
         }
         else if (item.id == null)

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/activity.yaml

@@ -41,3 +41,50 @@ properties:
     wishlist", the object of the activity is the movie added.
   range:
   - "https://www.w3.org/ns/activitystreams#Object"
+
+- pluralName: targets
+  singularName: target
+  singularAccessor: true
+  uri: "https://www.w3.org/ns/activitystreams#target"
+  description: |
+    Describes the indirect object, or target, of the activity.  The precise
+    meaning of the target is largely dependent on the type of action being
+    described but will often be the object of the English preposition "to".
+    For instance, in the activity "John added a movie to his wishlist",
+    the target of the activity is John's wishlist.  An activity can have more
+    than one target. 
+  range:
+  - "https://www.w3.org/ns/activitystreams#Object"
+
+- pluralName: results
+  singularName: result
+  singularAccessor: true
+  uri: "https://www.w3.org/ns/activitystreams#result"
+  description: |
+    Describes the result of the activity.  For instance, if a particular action
+    results in the creation of a new resource, the result property can be used
+    to describe that new resource. 
+  range:
+  - "https://www.w3.org/ns/activitystreams#Object"
+
+- pluralName: origins
+  singularName: origin
+  singularAccessor: true
+  uri: "https://www.w3.org/ns/activitystreams#origin"
+  description: |
+    Describes an indirect object of the activity from which the activity is
+    directed.  The precise meaning of the origin is the object of the English
+    preposition "from". For instance, in the activity "John moved an item to
+    List B from List A", the origin of the activity is "List A".
+  range:
+  - "https://www.w3.org/ns/activitystreams#Object"
+
+- pluralName: instruments
+  singularName: instrument
+  singularAccessor: true
+  uri: "https://www.w3.org/ns/activitystreams#instrument"
+  description: |
+    Identifies one or more objects used (or to be used) in the completion of
+    an {@link Activity}.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Object"

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/collection.yaml

@@ -30,7 +30,6 @@ properties:
     the most recently updated member items.
   range:
   - "https://www.w3.org/ns/activitystreams#CollectionPage"
-  - "https://www.w3.org/ns/activitystreams#Link"
 
 - singularName: first
   functional: true
@@ -40,7 +39,6 @@ properties:
     items in the collection.
   range:
   - "https://www.w3.org/ns/activitystreams#CollectionPage"
-  - "https://www.w3.org/ns/activitystreams#Link"
 
 - singularName: last
   functional: true
@@ -50,7 +48,6 @@ properties:
     the collection.
   range:
   - "https://www.w3.org/ns/activitystreams#CollectionPage"
-  - "https://www.w3.org/ns/activitystreams#Link"
 
 - pluralName: items
   singularName: item
@@ -60,4 +57,3 @@ properties:
     or unordered.
   range:
   - "https://www.w3.org/ns/activitystreams#Object"
-  - "https://www.w3.org/ns/activitystreams#Link"

package/esm/vocab/collectionpage.yaml

@@ -17,7 +17,6 @@ properties:
     Identifies the {@link Collection} to which a {@link CollectionPage} objects
     items belong.
   range:
-  - "https://www.w3.org/ns/activitystreams#Link"
   - "https://www.w3.org/ns/activitystreams#Collection"
 
 - singularName: next
@@ -26,7 +25,6 @@ properties:
   description: In a paged {@link Collection}, indicates the next page of items.
   range:
   - "https://www.w3.org/ns/activitystreams#CollectionPage"
-  - "https://www.w3.org/ns/activitystreams#Link"
 
 - singularName: prev
   functional: true
@@ -35,4 +33,3 @@ properties:
     In a paged {@link Collection}, identifies the previous page of items.
   range:
   - "https://www.w3.org/ns/activitystreams#CollectionPage"
-  - "https://www.w3.org/ns/activitystreams#Link"

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