@fedify/fedify 0.9.0-dev.171 → 0.9.0-dev.173

package/CHANGES.md

@@ -8,10 +8,28 @@ Version 0.9.0
 
 To be released.
 
+ -  Added `Hashtag` class to Activity Vocabulary API.  [[#48]]
+
+ -  Added `Emoji` class to Activity Vocabulary API.  [[#48]]
+
+ -  Added an actor handle normalization function.
+
+     -  Added `normalizeActorHandle()` function.
+     -  Added `NormalizeActorHandleOptions` interface.
+     -  The `getActorHandle()` function now guarantees that the returned
+        actor handle is normalized.
+     -  Added the second optional parameter to `getActorHandle()` function.
+     -  The return type of `getActorHandle()` function became
+        ``Promise<`@${string}@${string}` | `${string}@${string}`>``
+        (was ``Promise<`@${string}@${string}`>``).
+
  -  Added more log messages using the [LogTape] library.  Currently the below
     logger categories are used:
 
      -  `["fedify", "federation", "actor"]`
+     -  `["fedify", "federation", "http"]`
+
+[#48]: https://github.com/dahlia/fedify/issues/48
 
 
 Version 0.8.0
@@ -22,7 +40,7 @@ Released on May 6, 2024.
  -  The CLI toolchain for testing and debugging is now available on JSR:
     [@fedify/cli].  You can install it with
     `deno install -A --unstable-fs --unstable-kv --unstable-temporal -n fedify
-    jsr:@fedify/cli`, or download a standalone exectuable from the [releases]
+    jsr:@fedify/cli`, or download a standalone executable from the [releases]
     page.
 
      -  Added `fedify` command.

package/esm/federation/middleware.js

@@ -843,7 +843,26 @@ export class Federation {
      * @returns The response to the request.
      * @since 0.6.0
      */
-    async fetch(request, { onNotFound, onNotAcceptable, onUnauthorized, contextData, }) {
+    async fetch(request, options) {
+        const response = await this.#fetch(request, options);
+        const logger = getLogger(["fedify", "federation", "http"]);
+        const url = new URL(request.url);
+        const logTpl = "{method} {path}: {status}";
+        const values = {
+            method: request.method,
+            path: `${url.pathname}${url.search}`,
+            url: request.url,
+            status: response.status,
+        };
+        if (response.status >= 500)
+            logger.error(logTpl, values);
+        else if (response.status >= 400)
+            logger.warn(logTpl, values);
+        else
+            logger.info(logTpl, values);
+        return response;
+    }
+    async #fetch(request, { onNotFound, onNotAcceptable, onUnauthorized, contextData, }) {
         onNotFound ??= notFound;
         onNotAcceptable ??= notAcceptable;
         onUnauthorized ??= unauthorized;

package/esm/vocab/actor.js

@@ -1,3 +1,4 @@
+import { toASCII, toUnicode } from "node:punycode";
 import { lookupWebFinger } from "../webfinger/lookup.js";
 import { Application, Group, Organization, Person, Service } from "./vocab.js";
 /**
@@ -66,13 +67,15 @@ export function getActorClassByTypeName(typeName) {
  * ```
  *
  * @param actor The actor or actor URI to get the handle from.
+ * @param options The options for normalizing the actor handle.
  * @returns The actor handle.  It starts with `@` and is followed by the
- *          username and domain, separated by `@`.
+ *          username and domain, separated by `@` by default (it can be
+ *          customized with the options).
  * @throws {TypeError} If the actor does not have enough information to get the
  *                     handle.
  * @since 0.4.0
  */
-export async function getActorHandle(actor) {
+export async function getActorHandle(actor, options = {}) {
     const actorId = actor instanceof URL ? actor : actor.id;
     if (actorId != null) {
         const result = await lookupWebFinger(actorId);
@@ -82,14 +85,37 @@ export async function getActorHandle(actor) {
                 aliases.unshift(result.subject);
             for (const alias of aliases) {
                 const match = alias.match(/^acct:([^@]+)@([^@]+)$/);
-                if (match != null)
-                    return `@${match[1]}@${match[2]}`;
+                if (match != null) {
+                    return normalizeActorHandle(`@${match[1]}@${match[2]}`, options);
+                }
             }
         }
     }
     if (!(actor instanceof URL) && actor.preferredUsername != null &&
         actor.id != null) {
-        return `@${actor.preferredUsername}@${actor.id.host}`;
+        return normalizeActorHandle(`@${actor.preferredUsername}@${actor.id.host}`, options);
     }
     throw new TypeError("Actor does not have enough information to get the handle.");
 }
+/**
+ * Normalizes the given actor handle.
+ * @param handle The full handle of the actor to normalize.
+ * @param options The options for normalizing the actor handle.
+ * @returns The normalized actor handle.
+ * @throws {TypeError} If the actor handle is invalid.
+ */
+export function normalizeActorHandle(handle, options = {}) {
+    handle = handle.replace(/^@/, "");
+    const atPos = handle.indexOf("@");
+    if (atPos < 1)
+        throw new TypeError("Invalid actor handle.");
+    let domain = handle.substring(atPos + 1);
+    if (domain.length < 1 || domain.includes("@")) {
+        throw new TypeError("Invalid actor handle.");
+    }
+    domain = domain.toLowerCase();
+    domain = options.punycode ? toASCII(domain) : toUnicode(domain);
+    domain = domain.toLowerCase();
+    const user = handle.substring(0, atPos);
+    return options.trimLeadingAt ? `${user}@${domain}` : `@${user}@${domain}`;
+}

package/esm/vocab/announce.yaml

@@ -7,5 +7,10 @@ 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"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 properties: []

package/esm/vocab/article.yaml

@@ -4,5 +4,10 @@ uri: "https://www.w3.org/ns/activitystreams#Article"
 extends: "https://www.w3.org/ns/activitystreams#Object"
 entity: true
 description: Represents any kind of multi-paragraph written work.
-defaultContext: "https://www.w3.org/ns/activitystreams"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 properties: []

package/esm/vocab/create.yaml

@@ -4,5 +4,10 @@ uri: "https://www.w3.org/ns/activitystreams#Create"
 extends: "https://www.w3.org/ns/activitystreams#Activity"
 entity: true
 description: Indicates that the `actor` has created the `object`.
-defaultContext: "https://www.w3.org/ns/activitystreams"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 properties: []

package/esm/vocab/emoji.yaml

@@ -0,0 +1,11 @@
+$schema: ../codegen/schema.yaml
+name: Emoji
+uri: "http://joinmastodon.org/ns#Emoji"
+extends: "https://www.w3.org/ns/activitystreams#Object"
+entity: true
+description: Represents a custom emoji.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- toot: "http://joinmastodon.org/ns#"
+  Emoji: "toot:Emoji"
+properties: []

package/esm/vocab/hashtag.yaml

@@ -0,0 +1,13 @@
+$schema: ../codegen/schema.yaml
+name: Hashtag
+uri: "https://www.w3.org/ns/activitystreams#Hashtag"
+extends: "https://www.w3.org/ns/activitystreams#Link"
+entity: false
+description: |
+  A specialized {@link Link} that represents an #hashtag.
+
+  See also <https://swicg.github.io/miscellany/#Hashtag>.
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- Hashtag: "as:Hashtag"
+properties: []

package/esm/vocab/note.yaml

@@ -6,5 +6,10 @@ entity: true
 description: |
   Represents a short written work typically less than a single paragraph in
   length.
-defaultContext: "https://www.w3.org/ns/activitystreams"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 properties: []

package/esm/vocab/update.yaml

@@ -9,5 +9,10 @@ description: |
   set of modifications made to `object`.
 
   The `target` and `origin` typically have no defined meaning.
-defaultContext: "https://www.w3.org/ns/activitystreams"
+defaultContext:
+- "https://www.w3.org/ns/activitystreams"
+- toot: "http://joinmastodon.org/ns#"
+  sensitive: "as:sensitive"
+  Emoji: "toot:Emoji"
+  Hashtag: "as:Hashtag"
 properties: []