@fedify/vocab 2.4.0-dev.1528 → 2.4.0-dev.1564

package/src/application.yaml

@@ -12,9 +12,13 @@ defaultContext:
 - "https://www.w3.org/ns/did/v1"
 - "https://w3id.org/security/multikey/v1"
 - "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
 - alsoKnownAs:
     "@id": "as:alsoKnownAs"
     "@type": "@id"
+  featuredCollections:
+    "@id": "https://w3id.org/fep/7aa9#featuredCollections"
+    "@type": "@id"
   manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   movedTo:
     "@id": "as:movedTo"
@@ -196,6 +200,15 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredCollections
+  functional: true
+  compactName: featuredCollections
+  uri: "https://w3id.org/fep/7aa9#featuredCollections"
+  description: |
+    A collection of {@link FeaturedCollection}s created by this actor.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/src/featureauthorization.yaml

@@ -0,0 +1,33 @@
+$schema: ../../vocab-tools/schema.yaml
+name: FeatureAuthorization
+compactName: FeatureAuthorization
+uri: "https://w3id.org/fep/7aa9#FeatureAuthorization"
+extends: "https://www.w3.org/ns/activitystreams#Object"
+entity: true
+description: |
+  Proves that an actor consented to being included in a
+  {@link FeaturedCollection}.
+
+  See [FEP-7aa9](https://w3id.org/fep/7aa9) for details.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
+
+properties:
+- singularName: interactingObject
+  functional: true
+  compactName: interactingObject
+  uri: "https://gotosocial.org/ns#interactingObject"
+  description: The featured collection for which the authorization was granted.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Object"
+
+- singularName: interactionTarget
+  functional: true
+  compactName: interactionTarget
+  uri: "https://gotosocial.org/ns#interactionTarget"
+  description: The actor that was authorized to be featured.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Object"

package/src/featuredcollection.yaml

@@ -0,0 +1,41 @@
+$schema: ../../vocab-tools/schema.yaml
+name: FeaturedCollection
+compactName: FeaturedCollection
+uri: "https://w3id.org/fep/7aa9#FeaturedCollection"
+extends: "https://www.w3.org/ns/activitystreams#OrderedCollection"
+entity: true
+description: |
+  A curated collection of recommended actors or other objects.
+
+  See [FEP-7aa9](https://w3id.org/fep/7aa9) for details.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  discoverable: "toot:discoverable"
+  Hashtag: "as:Hashtag"
+
+properties:
+- singularName: topic
+  functional: true
+  compactName: topic
+  uri: "https://w3id.org/fep/7aa9#topic"
+  description: |
+    A single {@link Hashtag} object that represents the main topic or category
+    of this featured collection.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Hashtag"
+
+- singularName: discoverable
+  functional: true
+  compactName: discoverable
+  uri: "http://joinmastodon.org/ns#discoverable"
+  description: |
+    When present and set to `false`, signals that this featured collection is
+    not meant to be discovered by search, onboarding, or similar discovery
+    features.
+  range:
+  - "http://www.w3.org/2001/XMLSchema#boolean"

package/src/featureditem.yaml

@@ -0,0 +1,34 @@
+$schema: ../../vocab-tools/schema.yaml
+name: FeaturedItem
+compactName: FeaturedItem
+uri: "https://w3id.org/fep/7aa9#FeaturedItem"
+extends: "https://www.w3.org/ns/activitystreams#Object"
+entity: true
+description: |
+  A single entry in a {@link FeaturedCollection}.
+
+  See [FEP-7aa9](https://w3id.org/fep/7aa9) for details.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
+
+properties:
+- singularName: featuredObject
+  functional: true
+  compactName: featuredObject
+  uri: "https://w3id.org/fep/7aa9#featuredObject"
+  description: The object being featured.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Object"
+
+- singularName: featureAuthorization
+  functional: true
+  compactName: featureAuthorization
+  uri: "https://w3id.org/fep/7aa9#featureAuthorization"
+  description: |
+    The {@link FeatureAuthorization} proving that the featured actor consented
+    to inclusion in the featured collection.
+  range:
+  - "https://w3id.org/fep/7aa9#FeatureAuthorization"

package/src/featurerequest.yaml

@@ -0,0 +1,21 @@
+$schema: ../../vocab-tools/schema.yaml
+name: FeatureRequest
+compactName: FeatureRequest
+uri: "https://w3id.org/fep/7aa9#FeatureRequest"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  A request for consent before featuring an actor in a
+  {@link FeaturedCollection}.
+
+  The `object` property references the actor to be included, and the
+  `instrument` property references the featured collection.
+
+  See [FEP-7aa9](https://w3id.org/fep/7aa9) for details.
+defaultContext:
+- "https://w3id.org/identity/v1"
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/data-integrity/v1"
+- "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
+properties: []

package/src/group.yaml

@@ -12,9 +12,13 @@ defaultContext:
 - "https://www.w3.org/ns/did/v1"
 - "https://w3id.org/security/multikey/v1"
 - "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
 - alsoKnownAs:
     "@id": "as:alsoKnownAs"
     "@type": "@id"
+  featuredCollections:
+    "@id": "https://w3id.org/fep/7aa9#featuredCollections"
+    "@type": "@id"
   manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   movedTo:
     "@id": "as:movedTo"
@@ -196,6 +200,15 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredCollections
+  functional: true
+  compactName: featuredCollections
+  uri: "https://w3id.org/fep/7aa9#featuredCollections"
+  description: |
+    A collection of {@link FeaturedCollection}s created by this actor.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/src/interactionpolicy.yaml

@@ -12,9 +12,24 @@ description: |
 
   See [GoToSocial interaction controls](https://docs.gotosocial.org/en/latest/federation/interaction_controls/)
   for details.
-defaultContext: "https://gotosocial.org/ns"
+defaultContext:
+- "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
 
 properties:
+- singularName: canFeature
+  functional: true
+  compactName: canFeature
+  uri: "https://w3id.org/fep/7aa9#canFeature"
+  untyped: true
+  description: |
+    The sub-policy specifying who can feature the actor in a
+    {@link FeaturedCollection}.
+
+    See [FEP-7aa9](https://w3id.org/fep/7aa9) for details.
+  range:
+  - "https://gotosocial.org/ns#InteractionRule"
+
 - singularName: canLike
   functional: true
   compactName: canLike

package/src/organization.yaml

@@ -12,9 +12,13 @@ defaultContext:
 - "https://www.w3.org/ns/did/v1"
 - "https://w3id.org/security/multikey/v1"
 - "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
 - alsoKnownAs:
     "@id": "as:alsoKnownAs"
     "@type": "@id"
+  featuredCollections:
+    "@id": "https://w3id.org/fep/7aa9#featuredCollections"
+    "@type": "@id"
   manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   movedTo:
     "@id": "as:movedTo"
@@ -196,6 +200,15 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredCollections
+  functional: true
+  compactName: featuredCollections
+  uri: "https://w3id.org/fep/7aa9#featuredCollections"
+  description: |
+    A collection of {@link FeaturedCollection}s created by this actor.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/src/person.yaml

@@ -12,9 +12,13 @@ defaultContext:
 - "https://www.w3.org/ns/did/v1"
 - "https://w3id.org/security/multikey/v1"
 - "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
 - alsoKnownAs:
     "@id": "as:alsoKnownAs"
     "@type": "@id"
+  featuredCollections:
+    "@id": "https://w3id.org/fep/7aa9#featuredCollections"
+    "@type": "@id"
   manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   movedTo:
     "@id": "as:movedTo"
@@ -196,6 +200,15 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredCollections
+  functional: true
+  compactName: featuredCollections
+  uri: "https://w3id.org/fep/7aa9#featuredCollections"
+  description: |
+    A collection of {@link FeaturedCollection}s created by this actor.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/src/service.yaml

@@ -12,9 +12,13 @@ defaultContext:
 - "https://www.w3.org/ns/did/v1"
 - "https://w3id.org/security/multikey/v1"
 - "https://gotosocial.org/ns"
+- "https://w3id.org/fep/7aa9"
 - alsoKnownAs:
     "@id": "as:alsoKnownAs"
     "@type": "@id"
+  featuredCollections:
+    "@id": "https://w3id.org/fep/7aa9#featuredCollections"
+    "@type": "@id"
   manuallyApprovesFollowers: "as:manuallyApprovesFollowers"
   movedTo:
     "@id": "as:movedTo"
@@ -196,6 +200,15 @@ properties:
   range:
   - "https://www.w3.org/ns/activitystreams#Collection"
 
+- singularName: featuredCollections
+  functional: true
+  compactName: featuredCollections
+  uri: "https://w3id.org/fep/7aa9#featuredCollections"
+  description: |
+    A collection of {@link FeaturedCollection}s created by this actor.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Collection"
+
 - pluralName: streams
   singularName: stream
   singularAccessor: false

package/src/vocab.test.ts

@@ -36,6 +36,10 @@ import {
   Delete,
   Document,
   Endpoints,
+  FeatureAuthorization,
+  FeaturedCollection,
+  FeaturedItem,
+  FeatureRequest,
   Follow,
   Hashtag,
   Intent,
@@ -104,6 +108,23 @@ const QUOTE_REQUEST_CONTEXT = [
   },
 ] as const;
 
+const FEATURE_CONTEXT = [
+  "https://www.w3.org/ns/activitystreams",
+  "https://w3id.org/security/data-integrity/v1",
+  "https://gotosocial.org/ns",
+  "https://w3id.org/fep/7aa9",
+] as const;
+
+const FEATURED_COLLECTION_CONTEXT = [
+  ...FEATURE_CONTEXT,
+  {
+    Hashtag: "as:Hashtag",
+    discoverable: "toot:discoverable",
+    sensitive: "as:sensitive",
+    toot: "http://joinmastodon.org/ns#",
+  },
+] as const;
+
 const DELETE_QUOTE_REQUEST_CONTEXT = [
   "https://w3id.org/identity/v1",
   "https://www.w3.org/ns/activitystreams",
@@ -1734,6 +1755,7 @@ test("Person.toJsonLd()", async () => {
       "https://www.w3.org/ns/did/v1",
       "https://w3id.org/security/multikey/v1",
       "https://gotosocial.org/ns",
+      "https://w3id.org/fep/7aa9",
       {
         PropertyValue: "schema:PropertyValue",
         alsoKnownAs: {
@@ -1749,6 +1771,10 @@ test("Person.toJsonLd()", async () => {
           "@id": "toot:featured",
           "@type": "@id",
         },
+        featuredCollections: {
+          "@id": "https://w3id.org/fep/7aa9#featuredCollections",
+          "@type": "@id",
+        },
         featuredTags: {
           "@id": "toot:featuredTags",
           "@type": "@id",
@@ -2452,6 +2478,266 @@ test("InteractionPolicy.canQuote", async () => {
   );
 });
 
+test("InteractionPolicy.canFeature", async () => {
+  const person = new Person({
+    id: new URL("https://example.com/users/alice"),
+    featuredCollections: new URL(
+      "https://example.com/users/alice/featured_collections",
+    ),
+    interactionPolicy: new InteractionPolicy({
+      canFeature: new InteractionRule({
+        automaticApproval: new URL(
+          "https://www.w3.org/ns/activitystreams#Public",
+        ),
+      }),
+    }),
+  });
+  const expected = {
+    "@context": [
+      "https://www.w3.org/ns/activitystreams",
+      "https://w3id.org/security/v1",
+      "https://w3id.org/security/data-integrity/v1",
+      "https://www.w3.org/ns/did/v1",
+      "https://w3id.org/security/multikey/v1",
+      "https://gotosocial.org/ns",
+      "https://w3id.org/fep/7aa9",
+      {
+        Emoji: "toot:Emoji",
+        PropertyValue: "schema:PropertyValue",
+        _misskey_followedMessage: "misskey:_misskey_followedMessage",
+        alsoKnownAs: {
+          "@id": "as:alsoKnownAs",
+          "@type": "@id",
+        },
+        discoverable: "toot:discoverable",
+        featured: {
+          "@id": "toot:featured",
+          "@type": "@id",
+        },
+        featuredCollections: {
+          "@id": "https://w3id.org/fep/7aa9#featuredCollections",
+          "@type": "@id",
+        },
+        featuredTags: {
+          "@id": "toot:featuredTags",
+          "@type": "@id",
+        },
+        indexable: "toot:indexable",
+        isCat: "misskey:isCat",
+        manuallyApprovesFollowers: "as:manuallyApprovesFollowers",
+        memorial: "toot:memorial",
+        misskey: "https://misskey-hub.net/ns#",
+        movedTo: {
+          "@id": "as:movedTo",
+          "@type": "@id",
+        },
+        schema: "http://schema.org#",
+        suspended: "toot:suspended",
+        toot: "http://joinmastodon.org/ns#",
+        value: "schema:value",
+      },
+    ],
+    type: "Person",
+    id: "https://example.com/users/alice",
+    featuredCollections: "https://example.com/users/alice/featured_collections",
+    interactionPolicy: {
+      canFeature: {
+        automaticApproval: "as:Public",
+      },
+    },
+  };
+  deepStrictEqual(
+    await person.toJsonLd({ contextLoader: mockDocumentLoader }),
+    expected,
+  );
+
+  const loaded = await Person.fromJsonLd(expected, {
+    documentLoader: mockDocumentLoader,
+    contextLoader: mockDocumentLoader,
+  });
+  deepStrictEqual(
+    loaded.featuredCollectionsId,
+    new URL("https://example.com/users/alice/featured_collections"),
+  );
+  assertInstanceOf(loaded.interactionPolicy, InteractionPolicy);
+  assertInstanceOf(loaded.interactionPolicy.canFeature, InteractionRule);
+  deepStrictEqual(
+    loaded.interactionPolicy.canFeature.automaticApproval,
+    new URL("https://www.w3.org/ns/activitystreams#Public"),
+  );
+  deepStrictEqual(
+    await loaded.toJsonLd({ contextLoader: mockDocumentLoader }),
+    expected,
+  );
+
+  const loadedFromFepContext = await Person.fromJsonLd({
+    "@context": [
+      "https://www.w3.org/ns/activitystreams",
+      "https://gotosocial.org/ns",
+      "https://w3id.org/fep/7aa9",
+      {
+        featuredCollections: {
+          "@id": "https://w3id.org/fep/7aa9#featuredCollections",
+          "@type": "@id",
+        },
+      },
+    ],
+    type: "Person",
+    id: "https://example.com/users/alice",
+    featuredCollections: "https://example.com/users/alice/featured_collections",
+  }, {
+    documentLoader: mockDocumentLoader,
+    contextLoader: mockDocumentLoader,
+  });
+  deepStrictEqual(
+    loadedFromFepContext.featuredCollectionsId,
+    new URL("https://example.com/users/alice/featured_collections"),
+  );
+});
+
+test("FeaturedCollection.toJsonLd()", async () => {
+  const collection = new FeaturedCollection({
+    id: new URL("https://example.com/users/alice/featured/1"),
+    name: "Cute cats",
+    attribution: new URL("https://example.com/users/alice"),
+    topic: new Hashtag({ name: "#cats" }),
+    discoverable: false,
+    totalItems: 1,
+  });
+  const expected = {
+    "@context": FEATURED_COLLECTION_CONTEXT,
+    type: "FeaturedCollection",
+    id: "https://example.com/users/alice/featured/1",
+    attributedTo: "https://example.com/users/alice",
+    name: "Cute cats",
+    totalItems: 1,
+    topic: {
+      type: "Hashtag",
+      name: "#cats",
+    },
+    discoverable: false,
+  };
+  deepStrictEqual(
+    await collection.toJsonLd({ contextLoader: mockDocumentLoader }),
+    expected,
+  );
+
+  const loaded = await FeaturedCollection.fromJsonLd(expected, {
+    documentLoader: mockDocumentLoader,
+    contextLoader: mockDocumentLoader,
+  });
+  assertInstanceOf(loaded, FeaturedCollection);
+  deepStrictEqual(loaded.name, "Cute cats");
+  deepStrictEqual(
+    loaded.attributionId,
+    new URL("https://example.com/users/alice"),
+  );
+  assertInstanceOf(loaded.topic, Hashtag);
+  deepStrictEqual(loaded.topic.name, "#cats");
+  deepStrictEqual(loaded.discoverable, false);
+  deepStrictEqual(loaded.totalItems, 1);
+  deepStrictEqual(
+    await loaded.toJsonLd({ contextLoader: mockDocumentLoader }),
+    expected,
+  );
+});
+
+test("FeaturedItem.toJsonLd()", async () => {
+  const item = new FeaturedItem({
+    id: new URL("https://example.com/users/alice/featured/1/items/1"),
+    featuredObject: new URL("https://example.com/users/bob"),
+    featureAuthorization: new URL("https://example.com/users/bob/stamps/1"),
+  });
+  const expected = {
+    "@context": FEATURE_CONTEXT,
+    type: "FeaturedItem",
+    id: "https://example.com/users/alice/featured/1/items/1",
+    featuredObject: "https://example.com/users/bob",
+    featureAuthorization: "https://example.com/users/bob/stamps/1",
+  };
+  deepStrictEqual(
+    await item.toJsonLd({ contextLoader: mockDocumentLoader }),
+    expected,
+  );
+
+  const loaded = await FeaturedItem.fromJsonLd(expected, {
+    documentLoader: mockDocumentLoader,
+    contextLoader: mockDocumentLoader,
+  });
+  assertInstanceOf(loaded, FeaturedItem);
+  deepStrictEqual(
+    loaded.featuredObjectId,
+    new URL("https://example.com/users/bob"),
+  );
+  deepStrictEqual(
+    loaded.featureAuthorizationId,
+    new URL("https://example.com/users/bob/stamps/1"),
+  );
+});
+
+test("FeatureAuthorization.fromJsonLd()", async () => {
+  const jsonLd = {
+    "@context": FEATURE_CONTEXT,
+    type: "FeatureAuthorization",
+    id: "https://example.com/users/bob/stamps/1",
+    interactingObject: "https://example.com/users/alice/featured/1",
+    interactionTarget: "https://example.com/users/bob",
+  };
+  const authorization = await FeatureAuthorization.fromJsonLd(jsonLd, {
+    documentLoader: mockDocumentLoader,
+    contextLoader: mockDocumentLoader,
+  });
+  assertInstanceOf(authorization, FeatureAuthorization);
+  deepStrictEqual(
+    authorization.interactingObjectId,
+    new URL("https://example.com/users/alice/featured/1"),
+  );
+  deepStrictEqual(
+    authorization.interactionTargetId,
+    new URL("https://example.com/users/bob"),
+  );
+  deepStrictEqual(
+    await authorization.toJsonLd({ contextLoader: mockDocumentLoader }),
+    jsonLd,
+  );
+});
+
+test("FeatureRequest.toJsonLd()", async () => {
+  const request = new FeatureRequest({
+    id: new URL("https://example.com/users/alice/featured/1/requests/1"),
+    object: new URL("https://example.com/users/bob"),
+    instrument: new URL("https://example.com/users/alice/featured/1"),
+  });
+  const expected = {
+    "@context": [
+      "https://w3id.org/identity/v1",
+      ...FEATURE_CONTEXT,
+    ],
+    type: "FeatureRequest",
+    id: "https://example.com/users/alice/featured/1/requests/1",
+    object: "https://example.com/users/bob",
+    instrument: "https://example.com/users/alice/featured/1",
+  };
+  deepStrictEqual(
+    await request.toJsonLd({ contextLoader: mockDocumentLoader }),
+    expected,
+  );
+
+  const loaded = await FeatureRequest.fromJsonLd(expected, {
+    documentLoader: mockDocumentLoader,
+    contextLoader: mockDocumentLoader,
+  });
+  assertInstanceOf(loaded, FeatureRequest);
+  deepStrictEqual(
+    loaded.objectId,
+    new URL("https://example.com/users/bob"),
+  );
+  deepStrictEqual(
+    loaded.instrumentId,
+    new URL("https://example.com/users/alice/featured/1"),
+  );
+});
+
 test("QuoteAuthorization.fromJsonLd()", async () => {
   const jsonLd = {
     "@context": [