@fedify/fedify 0.5.0-dev.88

package/esm/testing/fixtures/www.w3.org/ns/activitystreams

@@ -0,0 +1,379 @@
+{
+  "@context": {
+    "@vocab": "_:",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "as": "https://www.w3.org/ns/activitystreams#",
+    "ldp": "http://www.w3.org/ns/ldp#",
+    "vcard": "http://www.w3.org/2006/vcard/ns#",
+    "id": "@id",
+    "type": "@type",
+    "Accept": "as:Accept",
+    "Activity": "as:Activity",
+    "IntransitiveActivity": "as:IntransitiveActivity",
+    "Add": "as:Add",
+    "Announce": "as:Announce",
+    "Application": "as:Application",
+    "Arrive": "as:Arrive",
+    "Article": "as:Article",
+    "Audio": "as:Audio",
+    "Block": "as:Block",
+    "Collection": "as:Collection",
+    "CollectionPage": "as:CollectionPage",
+    "Relationship": "as:Relationship",
+    "Create": "as:Create",
+    "Delete": "as:Delete",
+    "Dislike": "as:Dislike",
+    "Document": "as:Document",
+    "Event": "as:Event",
+    "Follow": "as:Follow",
+    "Flag": "as:Flag",
+    "Group": "as:Group",
+    "Ignore": "as:Ignore",
+    "Image": "as:Image",
+    "Invite": "as:Invite",
+    "Join": "as:Join",
+    "Leave": "as:Leave",
+    "Like": "as:Like",
+    "Link": "as:Link",
+    "Mention": "as:Mention",
+    "Note": "as:Note",
+    "Object": "as:Object",
+    "Offer": "as:Offer",
+    "OrderedCollection": "as:OrderedCollection",
+    "OrderedCollectionPage": "as:OrderedCollectionPage",
+    "Organization": "as:Organization",
+    "Page": "as:Page",
+    "Person": "as:Person",
+    "Place": "as:Place",
+    "Profile": "as:Profile",
+    "Question": "as:Question",
+    "Reject": "as:Reject",
+    "Remove": "as:Remove",
+    "Service": "as:Service",
+    "TentativeAccept": "as:TentativeAccept",
+    "TentativeReject": "as:TentativeReject",
+    "Tombstone": "as:Tombstone",
+    "Undo": "as:Undo",
+    "Update": "as:Update",
+    "Video": "as:Video",
+    "View": "as:View",
+    "Listen": "as:Listen",
+    "Read": "as:Read",
+    "Move": "as:Move",
+    "Travel": "as:Travel",
+    "IsFollowing": "as:IsFollowing",
+    "IsFollowedBy": "as:IsFollowedBy",
+    "IsContact": "as:IsContact",
+    "IsMember": "as:IsMember",
+    "subject": {
+      "@id": "as:subject",
+      "@type": "@id"
+    },
+    "relationship": {
+      "@id": "as:relationship",
+      "@type": "@id"
+    },
+    "actor": {
+      "@id": "as:actor",
+      "@type": "@id"
+    },
+    "attributedTo": {
+      "@id": "as:attributedTo",
+      "@type": "@id"
+    },
+    "attachment": {
+      "@id": "as:attachment",
+      "@type": "@id"
+    },
+    "bcc": {
+      "@id": "as:bcc",
+      "@type": "@id"
+    },
+    "bto": {
+      "@id": "as:bto",
+      "@type": "@id"
+    },
+    "cc": {
+      "@id": "as:cc",
+      "@type": "@id"
+    },
+    "context": {
+      "@id": "as:context",
+      "@type": "@id"
+    },
+    "current": {
+      "@id": "as:current",
+      "@type": "@id"
+    },
+    "first": {
+      "@id": "as:first",
+      "@type": "@id"
+    },
+    "generator": {
+      "@id": "as:generator",
+      "@type": "@id"
+    },
+    "icon": {
+      "@id": "as:icon",
+      "@type": "@id"
+    },
+    "image": {
+      "@id": "as:image",
+      "@type": "@id"
+    },
+    "inReplyTo": {
+      "@id": "as:inReplyTo",
+      "@type": "@id"
+    },
+    "items": {
+      "@id": "as:items",
+      "@type": "@id"
+    },
+    "instrument": {
+      "@id": "as:instrument",
+      "@type": "@id"
+    },
+    "orderedItems": {
+      "@id": "as:items",
+      "@type": "@id",
+      "@container": "@list"
+    },
+    "last": {
+      "@id": "as:last",
+      "@type": "@id"
+    },
+    "location": {
+      "@id": "as:location",
+      "@type": "@id"
+    },
+    "next": {
+      "@id": "as:next",
+      "@type": "@id"
+    },
+    "object": {
+      "@id": "as:object",
+      "@type": "@id"
+    },
+    "oneOf": {
+      "@id": "as:oneOf",
+      "@type": "@id"
+    },
+    "anyOf": {
+      "@id": "as:anyOf",
+      "@type": "@id"
+    },
+    "closed": {
+      "@id": "as:closed",
+      "@type": "xsd:dateTime"
+    },
+    "origin": {
+      "@id": "as:origin",
+      "@type": "@id"
+    },
+    "accuracy": {
+      "@id": "as:accuracy",
+      "@type": "xsd:float"
+    },
+    "prev": {
+      "@id": "as:prev",
+      "@type": "@id"
+    },
+    "preview": {
+      "@id": "as:preview",
+      "@type": "@id"
+    },
+    "replies": {
+      "@id": "as:replies",
+      "@type": "@id"
+    },
+    "result": {
+      "@id": "as:result",
+      "@type": "@id"
+    },
+    "audience": {
+      "@id": "as:audience",
+      "@type": "@id"
+    },
+    "partOf": {
+      "@id": "as:partOf",
+      "@type": "@id"
+    },
+    "tag": {
+      "@id": "as:tag",
+      "@type": "@id"
+    },
+    "target": {
+      "@id": "as:target",
+      "@type": "@id"
+    },
+    "to": {
+      "@id": "as:to",
+      "@type": "@id"
+    },
+    "url": {
+      "@id": "as:url",
+      "@type": "@id"
+    },
+    "altitude": {
+      "@id": "as:altitude",
+      "@type": "xsd:float"
+    },
+    "content": "as:content",
+    "contentMap": {
+      "@id": "as:content",
+      "@container": "@language"
+    },
+    "name": "as:name",
+    "nameMap": {
+      "@id": "as:name",
+      "@container": "@language"
+    },
+    "duration": {
+      "@id": "as:duration",
+      "@type": "xsd:duration"
+    },
+    "endTime": {
+      "@id": "as:endTime",
+      "@type": "xsd:dateTime"
+    },
+    "height": {
+      "@id": "as:height",
+      "@type": "xsd:nonNegativeInteger"
+    },
+    "href": {
+      "@id": "as:href",
+      "@type": "@id"
+    },
+    "hreflang": "as:hreflang",
+    "latitude": {
+      "@id": "as:latitude",
+      "@type": "xsd:float"
+    },
+    "longitude": {
+      "@id": "as:longitude",
+      "@type": "xsd:float"
+    },
+    "mediaType": "as:mediaType",
+    "published": {
+      "@id": "as:published",
+      "@type": "xsd:dateTime"
+    },
+    "radius": {
+      "@id": "as:radius",
+      "@type": "xsd:float"
+    },
+    "rel": "as:rel",
+    "startIndex": {
+      "@id": "as:startIndex",
+      "@type": "xsd:nonNegativeInteger"
+    },
+    "startTime": {
+      "@id": "as:startTime",
+      "@type": "xsd:dateTime"
+    },
+    "summary": "as:summary",
+    "summaryMap": {
+      "@id": "as:summary",
+      "@container": "@language"
+    },
+    "totalItems": {
+      "@id": "as:totalItems",
+      "@type": "xsd:nonNegativeInteger"
+    },
+    "units": "as:units",
+    "updated": {
+      "@id": "as:updated",
+      "@type": "xsd:dateTime"
+    },
+    "width": {
+      "@id": "as:width",
+      "@type": "xsd:nonNegativeInteger"
+    },
+    "describes": {
+      "@id": "as:describes",
+      "@type": "@id"
+    },
+    "formerType": {
+      "@id": "as:formerType",
+      "@type": "@id"
+    },
+    "deleted": {
+      "@id": "as:deleted",
+      "@type": "xsd:dateTime"
+    },
+    "inbox": {
+      "@id": "ldp:inbox",
+      "@type": "@id"
+    },
+    "outbox": {
+      "@id": "as:outbox",
+      "@type": "@id"
+    },
+    "following": {
+      "@id": "as:following",
+      "@type": "@id"
+    },
+    "followers": {
+      "@id": "as:followers",
+      "@type": "@id"
+    },
+    "streams": {
+      "@id": "as:streams",
+      "@type": "@id"
+    },
+    "preferredUsername": "as:preferredUsername",
+    "endpoints": {
+      "@id": "as:endpoints",
+      "@type": "@id"
+    },
+    "uploadMedia": {
+      "@id": "as:uploadMedia",
+      "@type": "@id"
+    },
+    "proxyUrl": {
+      "@id": "as:proxyUrl",
+      "@type": "@id"
+    },
+    "liked": {
+      "@id": "as:liked",
+      "@type": "@id"
+    },
+    "oauthAuthorizationEndpoint": {
+      "@id": "as:oauthAuthorizationEndpoint",
+      "@type": "@id"
+    },
+    "oauthTokenEndpoint": {
+      "@id": "as:oauthTokenEndpoint",
+      "@type": "@id"
+    },
+    "provideClientKey": {
+      "@id": "as:provideClientKey",
+      "@type": "@id"
+    },
+    "signClientKey": {
+      "@id": "as:signClientKey",
+      "@type": "@id"
+    },
+    "sharedInbox": {
+      "@id": "as:sharedInbox",
+      "@type": "@id"
+    },
+    "Public": {
+      "@id": "as:Public",
+      "@type": "@id"
+    },
+    "source": "as:source",
+    "likes": {
+      "@id": "as:likes",
+      "@type": "@id"
+    },
+    "shares": {
+      "@id": "as:shares",
+      "@type": "@id"
+    },
+    "alsoKnownAs": {
+      "@id": "as:alsoKnownAs",
+      "@type": "@id"
+    }
+  }
+}

package/esm/testing/keys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../src/testing/keys.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,uBAAuB,CAAC;AACjD,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAErD,eAAO,MAAM,UAAU,kBA2BrB,CAAC;AAEH,eAAO,MAAM,WAAW,mBAyCvB,CAAC;AAEF,eAAO,MAAM,UAAU,kBAuBrB,CAAC"}

package/esm/vocab/accept.yaml

@@ -0,0 +1,11 @@
+$schema: ../codegen/schema.yaml
+name: Accept
+uri: "https://www.w3.org/ns/activitystreams#Accept"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Indicates that the `actor` accepts the `object`.  The `target` property can be
+  used in certain circumstances to indicate the context into which the `object`
+  has been accepted.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+properties: []

package/esm/vocab/activity.yaml

@@ -0,0 +1,42 @@
+$schema: ../codegen/schema.yaml
+name: Activity
+uri: "https://www.w3.org/ns/activitystreams#Activity"
+extends: "https://www.w3.org/ns/activitystreams#Object"
+entity: true
+description: |
+  An Activity is a subtype of {@link Object} that describes some form of action
+  that may happen, is currently happening, or has already happened.
+  The {@link Activity} type itself serves as an abstract base type for all types
+  of activities.  It is important to note that the {@link Activity} type itself
+  does not carry any specific semantics about the kind of action being taken.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- "https://w3id.org/security/v1"
+
+properties:
+- pluralName: actors
+  singularName: actor
+  singularAccessor: true
+  uri: "https://www.w3.org/ns/activitystreams#actor"
+  subpropertyOf: "https://www.w3.org/ns/activitystreams#attributedTo"
+  description: |
+    Describes one or more entities that either performed or are expected to
+    perform the activity.  Any single activity can have multiple actors.
+    The actor MAY be specified using an indirect {@link Link}.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Application"
+  - "https://www.w3.org/ns/activitystreams#Group"
+  - "https://www.w3.org/ns/activitystreams#Organization"
+  - "https://www.w3.org/ns/activitystreams#Person"
+  - "https://www.w3.org/ns/activitystreams#Service"
+
+- pluralName: objects
+  singularName: object
+  singularAccessor: true
+  uri: "https://www.w3.org/ns/activitystreams#object"
+  description: |
+    When used within an {@link Activity}, describes the direct object of
+    the activity.  For instance, in the activity "John added a movie to his
+    wishlist", the object of the activity is the movie added.
+  range:
+  - "https://www.w3.org/ns/activitystreams#Object"

package/esm/vocab/actor.d.ts

@@ -0,0 +1,52 @@
+/// <reference types="node" />
+import { Application, Group, Organization, Person, Service } from "./vocab.js";
+/**
+ * Actor types are {@link Object} types that are capable of performing
+ * activities.
+ */
+export type Actor = Application | Group | Organization | Person | Service;
+/**
+ * Checks if the given object is an {@link Actor}.
+ * @param object The object to check.
+ * @returns `true` if the given object is an {@link Actor}.
+ */
+export declare function isActor(object: unknown): object is Actor;
+/**
+ * A string representation of an actor type name.
+ */
+export type ActorTypeName = "Application" | "Group" | "Organization" | "Person" | "Service";
+/**
+ * Gets the type name of the given actor.
+ * @param actor The actor to get the type name of.
+ * @returns The type name of the given actor.
+ */
+export declare function getActorTypeName(actor: Actor): ActorTypeName;
+/**
+ * Gets the actor class by the given type name.
+ * @param typeName The type name to get the actor class by.
+ * @returns The actor class by the given type name.
+ */
+export declare function getActorClassByTypeName(typeName: ActorTypeName): typeof Application | typeof Group | typeof Organization | typeof Person | typeof Service;
+/**
+ * Gets the actor handle, of the form `@username@domain`, from the given actor
+ * or an actor URI.
+ *
+ * @example
+ * ``` typescript
+ * // Get the handle of an actor object:
+ * await getActorHandle(
+ *   new Person({ id: new URL("https://todon.eu/users/hongminhee") })
+ * );
+ *
+ * // Get the handle of an actor URI:
+ * await getActorHandle(new URL("https://todon.eu/users/hongminhee"));
+ * ```
+ *
+ * @param actor The actor or actor URI to get the handle from.
+ * @returns The actor handle.  It starts with `@` and is followed by the
+ *          username and domain, separated by `@`.
+ * @throws {TypeError} If the actor does not have enough information to get the
+ *                     handle.
+ */
+export declare function getActorHandle(actor: Actor | URL): Promise<`@${string}@${string}`>;
+//# sourceMappingURL=actor.d.ts.map

package/esm/vocab/actor.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actor.d.ts","sourceRoot":"","sources":["../../src/vocab/actor.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,WAAW,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,YAAY,CAAC;AAE/E;;;GAGG;AACH,MAAM,MAAM,KAAK,GAAG,WAAW,GAAG,KAAK,GAAG,YAAY,GAAG,MAAM,GAAG,OAAO,CAAC;AAE1E;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,KAAK,CAQxD;AAED;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,aAAa,GACb,OAAO,GACP,cAAc,GACd,QAAQ,GACR,SAAS,CAAC;AAEd;;;;GAIG;AACH,wBAAgB,gBAAgB,CAC9B,KAAK,EAAE,KAAK,GACX,aAAa,CAOf;AAED;;;;GAIG;AACH,wBAAgB,uBAAuB,CACrC,QAAQ,EAAE,aAAa,GAErB,OAAO,WAAW,GAClB,OAAO,KAAK,GACZ,OAAO,YAAY,GACnB,OAAO,MAAM,GACb,OAAO,OAAO,CAcjB;AAED;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,cAAc,CAClC,KAAK,EAAE,KAAK,GAAG,GAAG,GACjB,OAAO,CAAC,IAAI,MAAM,IAAI,MAAM,EAAE,CAAC,CAsBjC"}

package/esm/vocab/actor.js

@@ -0,0 +1,94 @@
+import { lookupWebFinger } from "../webfinger/lookup.js";
+import { Application, Group, Organization, Person, Service } from "./vocab.js";
+/**
+ * Checks if the given object is an {@link Actor}.
+ * @param object The object to check.
+ * @returns `true` if the given object is an {@link Actor}.
+ */
+export function isActor(object) {
+    return (object instanceof Application ||
+        object instanceof Group ||
+        object instanceof Organization ||
+        object instanceof Person ||
+        object instanceof Service);
+}
+/**
+ * Gets the type name of the given actor.
+ * @param actor The actor to get the type name of.
+ * @returns The type name of the given actor.
+ */
+export function getActorTypeName(actor) {
+    if (actor instanceof Application)
+        return "Application";
+    else if (actor instanceof Group)
+        return "Group";
+    else if (actor instanceof Organization)
+        return "Organization";
+    else if (actor instanceof Person)
+        return "Person";
+    else if (actor instanceof Service)
+        return "Service";
+    throw new Error("Unknown actor type.");
+}
+/**
+ * Gets the actor class by the given type name.
+ * @param typeName The type name to get the actor class by.
+ * @returns The actor class by the given type name.
+ */
+export function getActorClassByTypeName(typeName) {
+    switch (typeName) {
+        case "Application":
+            return Application;
+        case "Group":
+            return Group;
+        case "Organization":
+            return Organization;
+        case "Person":
+            return Person;
+        case "Service":
+            return Service;
+    }
+    throw new Error("Unknown actor type name.");
+}
+/**
+ * Gets the actor handle, of the form `@username@domain`, from the given actor
+ * or an actor URI.
+ *
+ * @example
+ * ``` typescript
+ * // Get the handle of an actor object:
+ * await getActorHandle(
+ *   new Person({ id: new URL("https://todon.eu/users/hongminhee") })
+ * );
+ *
+ * // Get the handle of an actor URI:
+ * await getActorHandle(new URL("https://todon.eu/users/hongminhee"));
+ * ```
+ *
+ * @param actor The actor or actor URI to get the handle from.
+ * @returns The actor handle.  It starts with `@` and is followed by the
+ *          username and domain, separated by `@`.
+ * @throws {TypeError} If the actor does not have enough information to get the
+ *                     handle.
+ */
+export async function getActorHandle(actor) {
+    const actorId = actor instanceof URL ? actor : actor.id;
+    if (actorId != null) {
+        const result = await lookupWebFinger(actorId);
+        if (result != null) {
+            const aliases = [...(result.aliases ?? [])];
+            if (result.subject != null)
+                aliases.unshift(result.subject);
+            for (const alias of aliases) {
+                const match = alias.match(/^acct:([^@]+)@([^@]+)$/);
+                if (match != null)
+                    return `@${match[1]}@${match[2]}`;
+            }
+        }
+    }
+    if (!(actor instanceof URL) && actor.preferredUsername != null &&
+        actor.id != null) {
+        return `@${actor.preferredUsername}@${actor.id.host}`;
+    }
+    throw new TypeError("Actor does not have enough information to get the handle.");
+}

package/esm/vocab/actor.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actor.test.d.ts","sourceRoot":"","sources":["../../src/vocab/actor.test.ts"],"names":[],"mappings":"AAAA,OAAO,2BAA2B,CAAC"}

package/esm/vocab/add.yaml

@@ -0,0 +1,12 @@
+$schema: ../codegen/schema.yaml
+name: Add
+uri: "https://www.w3.org/ns/activitystreams#Add"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Indicates that the `actor` has added the `object` to the `target`.
+  If the `target` property is not explicitly specified, the target would need
+  to be determined implicitly by context.  The `origin` can be used to identify
+  the context from which the `object` originated.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+properties: []

package/esm/vocab/announce.yaml

@@ -0,0 +1,11 @@
+$schema: ../codegen/schema.yaml
+name: Announce
+uri: "https://www.w3.org/ns/activitystreams#Announce"
+extends: "https://www.w3.org/ns/activitystreams#Activity"
+entity: true
+description: |
+  Indicates that the `actor` is calling the `target`'s attention the `object`.
+
+  The `origin` typically has no defined meaning.
+defaultContext: "https://www.w3.org/ns/activitystreams"
+properties: []