@fedify/fedify 0.11.0-dev.243 → 0.11.0-dev.244

package/CHANGES.md

@@ -25,6 +25,10 @@ To be released.
      -  Added `Context.getFeaturedUri()` method.
      -  Added `{ type: "featured"; handle: string }` case to `ParseUriResult`
         type.
+     -  Added `Federation.setFeaturedTagsDispatcher()` method.
+     -  Added `Context.getFeaturedTagsUri()` method.
+     -  Added `{ type: "featuredTags"; handle: string }` case to
+        `ParseUriResult` type.
 
  -  Frequently used JSON-LD contexts are now preloaded.  [[#74]]
 
@@ -49,15 +53,64 @@ To be released.
      -  `Collection.current`
      -  `Collection.first`
      -  `Collection.last`
-     -  `Collection.items`
      -  `CollectionPage.partOf`
      -  `CollectionPage.next`
      -  `CollectionPage.prev`
 
+ -  Added `featured` property to `Actor` types in Activity Vocabulary API.
+    [[#78]]
+
+     -  Added `Application.getFeatured()` method.
+     -  Added `Application.featuredId` property.
+     -  `new Application()` constructor now accepts `featured` option.
+     -  `Application.clone()` method now accepts `featured` option.
+     -  Added `Group.getFeatured()` method.
+     -  Added `Group.featuredId` property.
+     -  `new Group()` constructor now accepts `featured` option.
+     -  `Group.clone()` method now accepts `featured` option.
+     -  Added `Organization.getFeatured()` method.
+     -  Added `Organization.featuredId` property.
+     -  `new Organization()` constructor now accepts `featured` option.
+     -  `Organization.clone()` method now accepts `featured` option.
+     -  Added `Person.getFeatured()` method.
+     -  Added `Person.featuredId` property.
+     -  `new Person()` constructor now accepts `featured` option.
+     -  `Person.clone()` method now accepts `featured` option.
+     -  Added `Service.getFeatured()` method.
+     -  Added `Service.featuredId` property.
+     -  `new Service()` constructor now accepts `featured` option.
+     -  `Service.clone()` method now accepts `featured` option.
+
+ -  Added `featuredTags` property to `Actor` types in Activity Vocabulary API.
+    [[#78]]
+
+     -  Added `Application.getFeaturedTags()` method.
+     -  Added `Application.featuredTagsId` property.
+     -  `new Application()` constructor now accepts `featuredTags` option.
+     -  `Application.clone()` method now accepts `featuredTags` option.
+     -  Added `Group.getFeaturedTags()` method.
+     -  Added `Group.featuredTagsId` property.
+     -  `new Group()` constructor now accepts `featuredTags` option.
+     -  `Group.clone()` method now accepts `featuredTags` option.
+     -  Added `Organization.getFeaturedTags()` method.
+     -  Added `Organization.featuredTagsId` property.
+     -  `new Organization()` constructor now accepts `featuredTags` option.
+     -  `Organization.clone()` method now accepts `featuredTags` option.
+     -  Added `Person.getFeaturedTags()` method.
+     -  Added `Person.featuredTagsId` property.
+     -  `new Person()` constructor now accepts `featuredTags` option.
+     -  `Person.clone()` method now accepts `featuredTags` option.
+     -  Added `Service.getFeaturedTags()` method.
+     -  Added `Service.featuredTagsId` property.
+     -  `new Service()` constructor now accepts `featuredTags` option.
+     -  `Service.clone()` method now accepts `featuredTags` option.
+
  -  Added `target` property to `Activity` class in Activity Vocabulary API.
 
      -  Added `Activity.getTarget()` method.
      -  Added `Activity.getTargets()` method.
+     -  Added `Activity.targetId` property.
+     -  Added `Activity.targetIds` property.
      -  `new Activity()` constructor now accepts `target` option.
      -  `new Activity()` constructor now accepts `targets` option.
      -  `Activity.clone()` method now accepts `target` option.
@@ -67,6 +120,8 @@ To be released.
 
      -  Added `Activity.getResult()` method.
      -  Added `Activity.getResults()` method.
+     -  Added `Activity.resultId` property.
+     -  Added `Activity.resultIds` property.
      -  `new Activity()` constructor now accepts `result` option.
      -  `new Activity()` constructor now accepts `results` option.
      -  `Activity.clone()` method now accepts `result` option.
@@ -76,6 +131,8 @@ To be released.
 
      -  Added `Activity.getOrigin()` method.
      -  Added `Activity.getOrigins()` method.
+     -  Added `Activity.originId` property.
+     -  Added `Activity.originIds` property.
      -  `new Activity()` constructor now accepts `origin` option.
      -  `new Activity()` constructor now accepts `origins` option.
      -  `Activity.clone()` method now accepts `origin` option.
@@ -85,6 +142,8 @@ To be released.
 
      -  Added `Activity.getInstrument()` method.
      -  Added `Activity.getInstruments()` method.
+     -  Added `Activity.instrumentId` property.
+     -  Added `Activity.instrumentIds` property.
      -  `new Activity()` constructor now accepts `instrument` option.
      -  `new Activity()` constructor now accepts `instruments` option.
      -  `Activity.clone()` method now accepts `instrument` option.

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, Object, OrderedCollection, OrderedCollectionPage, } from "../vocab/vocab.js";
+import { Activity, Link, 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 URL) {
+        if (item instanceof Object || item instanceof Link || item instanceof URL) {
             mappedItem = item;
         }
         else if (item.id == null)

package/esm/federation/middleware.js

@@ -49,6 +49,7 @@ export class Federation {
     #followersCallbacks;
     #likedCallbacks;
     #featuredCallbacks;
+    #featuredTagsCallbacks;
     #inboxListeners;
     #inboxErrorHandler;
     #sharedInboxKeyDispatcher;
@@ -348,6 +349,20 @@ export class Federation {
                             "URI.  Set the property with Context.getFeaturedUri(handle).");
                     }
                 }
+                if (this.#featuredTagsCallbacks != null &&
+                    this.#featuredTagsCallbacks.dispatcher != null) {
+                    if (actor?.featuredTagsId == null) {
+                        logger.warn("You configured a featured tags collection dispatcher, but the " +
+                            "actor does not have a featuredTags property.  Set the property " +
+                            "with Context.getFeaturedTagsUri(handle).");
+                    }
+                    else if (actor.featuredTagsId.href != context.getFeaturedTagsUri(handle).href) {
+                        logger.warn("You configured a featured tags collection dispatcher, but the " +
+                            "actor's featuredTags property does not match the featured tags " +
+                            "collection URI.  Set the property with " +
+                            "Context.getFeaturedTagsUri(handle).");
+                    }
+                }
                 if (this.#router.has("inbox")) {
                     if (actor.inboxId == null) {
                         logger.warn("You configured inbox listeners, but the actor does not " +
@@ -716,6 +731,51 @@ export class Federation {
         };
         return setters;
     }
+    /**
+     * Registers a featured tags collection dispatcher.
+     * @param path The URI path pattern for the featured tags 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 tags collection callback to register.
+     * @returns An object with methods to set other featured tags collection
+     *          callbacks.
+     * @throws {@link RouterError} Thrown if the path pattern is invalid.
+     * @since 0.11.0
+     */
+    setFeaturedTagsDispatcher(path, dispatcher) {
+        if (this.#router.has("featuredTags")) {
+            throw new RouterError("Featured tags collection dispatcher already set.");
+        }
+        const variables = this.#router.add(path, "featuredTags");
+        if (variables.size !== 1 || !variables.has("handle")) {
+            throw new RouterError("Path for featured tags collection dispatcher must have one " +
+                "variable: {handle}");
+        }
+        const callbacks = {
+            dispatcher,
+        };
+        this.#featuredTagsCallbacks = 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.
      *
@@ -1062,6 +1122,16 @@ export class Federation {
                     onNotFound,
                     onNotAcceptable,
                 });
+            case "featuredTags":
+                return await handleCollection(request, {
+                    name: "featured tags",
+                    handle: route.values.handle,
+                    context,
+                    collectionCallbacks: this.#featuredTagsCallbacks,
+                    onUnauthorized,
+                    onNotFound,
+                    onNotAcceptable,
+                });
             default: {
                 const response = onNotFound(request);
                 return response instanceof Promise ? await response : response;
@@ -1174,6 +1244,13 @@ class ContextImpl {
         }
         return new URL(path, this.#url);
     }
+    getFeaturedTagsUri(handle) {
+        const path = this.#router.build("featuredTags", { handle });
+        if (path == null) {
+            throw new RouterError("No featured tags collection path registered.");
+        }
+        return new URL(path, this.#url);
+    }
     parseUri(uri) {
         if (uri.origin !== this.#url.origin)
             return null;
@@ -1213,6 +1290,9 @@ class ContextImpl {
         else if (route.name === "featured") {
             return { type: "featured", handle: route.values.handle };
         }
+        else if (route.name === "featuredTags") {
+            return { type: "featuredTags", handle: route.values.handle };
+        }
         return null;
     }
     getHandleFromActorUri(actorUri) {

package/esm/vocab/application.yaml

@@ -15,6 +15,9 @@ defaultContext:
   featured:
     "@id": "toot:featured"
     "@type": "@id"
+  featuredTags:
+    "@id": "toot:featuredTags"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -157,6 +160,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredTags
+  functional: true
+  uri: "http://joinmastodon.org/ns#featuredTags"
+  description: |
+    What is known in Mastodon as "featured hashtags", hashtags that are featured
+    at people's profiles, is implemented using an extra property `featuredTags`
+    on the actor object that points to a {@link Collection} of {@link Hashtag}
+    objects specifically.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/esm/vocab/collection.yaml

@@ -9,7 +9,13 @@ description: |
 
   Refer to the Activity Streams 2.0 Core specification for a complete
   description of the Collection type.
-defaultContext: "https://www.w3.org/ns/activitystreams"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 
 properties:
 - singularName: totalItems
@@ -57,3 +63,4 @@ properties:
     or unordered.
   range:
   - "https://www.w3.org/ns/activitystreams#Object"
+  - "https://www.w3.org/ns/activitystreams#Link"

package/esm/vocab/collectionpage.yaml

@@ -7,7 +7,13 @@ description: |
   Used to represent distinct subsets of items from a `Collection`.
   Refer to the Activity Streams 2.0 Core for a complete description of
   the `CollectionPage` object.
-defaultContext: "https://www.w3.org/ns/activitystreams"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 
 properties:
 - singularName: partOf

package/esm/vocab/group.yaml

@@ -15,6 +15,9 @@ defaultContext:
   featured:
     "@id": "toot:featured"
     "@type": "@id"
+  featuredTags:
+    "@id": "toot:featuredTags"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -157,6 +160,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredTags
+  functional: true
+  uri: "http://joinmastodon.org/ns#featuredTags"
+  description: |
+    What is known in Mastodon as "featured hashtags", hashtags that are featured
+    at people's profiles, is implemented using an extra property `featuredTags`
+    on the actor object that points to a {@link Collection} of {@link Hashtag}
+    objects specifically.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/esm/vocab/orderedcollection.yaml

@@ -6,7 +6,13 @@ entity: true
 description: |
   A subtype of {@link Collection} in which members of the logical collection
   are assumed to always be strictly ordered.
-defaultContext: "https://www.w3.org/ns/activitystreams"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 
 properties:
 - pluralName: items
@@ -18,3 +24,4 @@ properties:
     or unordered.
   range:
   - "https://www.w3.org/ns/activitystreams#Object"
+  - "https://www.w3.org/ns/activitystreams#Link"

package/esm/vocab/orderedcollectionpage.yaml

@@ -7,7 +7,13 @@ description: |
   Used to represent ordered subsets of items from an `OrderedCollection`.
   Refer to the Activity Streams 2.0 Core for a complete description of
   the `OrderedCollectionPage` object.
-defaultContext: "https://www.w3.org/ns/activitystreams"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 
 properties:
 - singularName: startIndex

package/esm/vocab/organization.yaml

@@ -15,6 +15,9 @@ defaultContext:
   featured:
     "@id": "toot:featured"
     "@type": "@id"
+  featuredTags:
+    "@id": "toot:featuredTags"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -157,6 +160,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredTags
+  functional: true
+  uri: "http://joinmastodon.org/ns#featuredTags"
+  description: |
+    What is known in Mastodon as "featured hashtags", hashtags that are featured
+    at people's profiles, is implemented using an extra property `featuredTags`
+    on the actor object that points to a {@link Collection} of {@link Hashtag}
+    objects specifically.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/esm/vocab/person.yaml

@@ -15,6 +15,9 @@ defaultContext:
   featured:
     "@id": "toot:featured"
     "@type": "@id"
+  featuredTags:
+    "@id": "toot:featuredTags"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -157,6 +160,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredTags
+  functional: true
+  uri: "http://joinmastodon.org/ns#featuredTags"
+  description: |
+    What is known in Mastodon as "featured hashtags", hashtags that are featured
+    at people's profiles, is implemented using an extra property `featuredTags`
+    on the actor object that points to a {@link Collection} of {@link Hashtag}
+    objects specifically.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/esm/vocab/service.yaml

@@ -15,6 +15,9 @@ defaultContext:
   featured:
     "@id": "toot:featured"
     "@type": "@id"
+  featuredTags:
+    "@id": "toot:featuredTags"
+    "@type": "@id"
   discoverable: "toot:discoverable"
   suspended: "toot:suspended"
   memorial: "toot:memorial"
@@ -157,6 +160,17 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredTags
+  functional: true
+  uri: "http://joinmastodon.org/ns#featuredTags"
+  description: |
+    What is known in Mastodon as "featured hashtags", hashtags that are featured
+    at people's profiles, is implemented using an extra property `featuredTags`
+    on the actor object that points to a {@link Collection} of {@link Hashtag}
+    objects specifically.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false