@fedify/fedify 1.0.0-dev.402 → 1.0.0-dev.404

package/CHANGES.md

@@ -8,6 +8,72 @@ Version 1.0.0
 
 To be released.
 
+ -  The term `handle` for dispatching actors is deprecated in favor of
+    `identifier`.
+
+     -  The URI template for the following methods now accepts variable
+        `{identifier}` instead of `{handle}`:
+
+         -  `Federation.setActorDispatcher()`
+         -  `Federation.setInboxDispatcher()`
+         -  `Federation.setOutboxDispatcher()`
+         -  `Federation.setFollowingDispatcher()`
+         -  `Federation.setFollowersDispatcher()`
+         -  `Federation.setLikedDispatcher()`
+         -  `Federation.setFeaturedDispatcher()`
+         -  `Federation.setFeaturedTagsDispatcher()`
+         -  `Federation.setInboxListeners()`
+
+        The `{handle}` variable is deprecated, and it will be removed in
+        the future.
+     -  The type of `Federation.setActorDispatcher()` method's first parameter
+        became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Federation.setInboxDispatcher()` method's first parameter
+        became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Federation.setOutboxDispatcher()` method's first parameter
+        became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Federation.setFollowingDispatcher()` method's first
+        parameter became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Federation.setFollowersDispatcher()` method's first
+        parameter became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Federation.setLikedDispatcher()` method's first parameter
+        became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Federation.setFeaturedDispatcher()` method's first
+        parameter became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Federation.setFeaturedTagsDispatcher()` method's first
+        parameter became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Federation.setInboxListeners()` method's first parameter
+        became ```${string}{identifier}${string}` |
+        `${string}{handle}${string}``` (was ```${string}{handle}${string}```).
+     -  The type of `Context.getDocumentLoader()` method's first parameter
+        became `{ identifier: string } | { username: string } | { handle:
+        string } | { keyId: URL; privateKey: CryptoKey }` (was `{ handle:
+        string } | { keyId: URL; privateKey: CryptoKey }`).
+     -  Passing `{ handle: string }` to `Context.getDocumentLoader()` method is
+        deprecated in favor of `{ username: string }`.
+     -  The type of `Context.sendActivity()` method's first parameter became
+        `SenderKeyPair | SenderKeyPair[] | { identifier: string } | { handle:
+        string }` (was `SenderKeyPair | SenderKeyPair[] | { handle: string }`).
+     -  All properties of `ParseUriResult` type became readonly.
+     -  Added `identifier` properties next to `handle` properties in
+        `ParseUriResult` type.
+     -  The `handle` properties of `ParseUriResult` type are deprecated in favor
+        of `identifier` properties.
+     -  The return type of `SharedInboxKeyDispatcher` callback type became
+        `SenderKeyPair | { identifier: string } | { username: string } |
+        { handle: string } | null | Promise<SenderKeyPair | { identifier:
+        string } | { username: string } | { handle: string } | null>`
+        (was `SenderKeyPair | { handle: string } | null |
+        Promise<SenderKeyPair | { handle: string } | null>`).
+
  -  Fedify now supports [Linked Data Signatures], which is outdated but still
     widely used in the fediverse.
 

package/esm/federation/handler.js

@@ -17,15 +17,15 @@ export function acceptsJsonLd(request) {
         types.includes("application/ld+json") ||
         types.includes("application/json");
 }
-export async function handleActor(request, { handle, context, actorDispatcher, authorizePredicate, onNotFound, onNotAcceptable, onUnauthorized, }) {
+export async function handleActor(request, { identifier, context, actorDispatcher, authorizePredicate, onNotFound, onNotAcceptable, onUnauthorized, }) {
     const logger = getLogger(["fedify", "federation", "actor"]);
     if (actorDispatcher == null) {
-        logger.debug("Actor dispatcher is not set.", { handle });
+        logger.debug("Actor dispatcher is not set.", { identifier });
         return await onNotFound(request);
     }
-    const actor = await actorDispatcher(context, handle);
+    const actor = await actorDispatcher(context, identifier);
     if (actor == null) {
-        logger.debug("Actor {handle} not found.", { handle });
+        logger.debug("Actor {identifier} not found.", { identifier });
         return await onNotFound(request);
     }
     if (!acceptsJsonLd(request))
@@ -33,7 +33,7 @@ export async function handleActor(request, { handle, context, actorDispatcher, a
     if (authorizePredicate != null) {
         const key = await context.getSignedKey();
         const keyOwner = await context.getSignedKeyOwner();
-        if (!await authorizePredicate(context, handle, key, keyOwner)) {
+        if (!await authorizePredicate(context, identifier, key, keyOwner)) {
             return await onUnauthorized(request);
         }
     }
@@ -68,18 +68,18 @@ export async function handleObject(request, { values, context, objectDispatcher,
         },
     });
 }
-export async function handleCollection(request, { name, handle, uriGetter, filter, filterPredicate, context, collectionCallbacks, onUnauthorized, onNotFound, onNotAcceptable, }) {
+export async function handleCollection(request, { name, identifier, uriGetter, filter, filterPredicate, context, collectionCallbacks, onUnauthorized, onNotFound, onNotAcceptable, }) {
     if (collectionCallbacks == null)
         return await onNotFound(request);
     const url = new URL(request.url);
     const cursor = url.searchParams.get("cursor");
     let collection;
-    const baseUri = uriGetter(handle);
+    const baseUri = uriGetter(identifier);
     if (cursor == null) {
-        const firstCursor = await collectionCallbacks.firstCursor?.(context, handle);
-        const totalItems = await collectionCallbacks.counter?.(context, handle);
+        const firstCursor = await collectionCallbacks.firstCursor?.(context, identifier);
+        const totalItems = await collectionCallbacks.counter?.(context, identifier);
         if (firstCursor == null) {
-            const page = await collectionCallbacks.dispatcher(context, handle, null, filter);
+            const page = await collectionCallbacks.dispatcher(context, identifier, null, filter);
             if (page == null)
                 return await onNotFound(request);
             const { items } = page;
@@ -90,7 +90,7 @@ export async function handleCollection(request, { name, handle, uriGetter, filte
             });
         }
         else {
-            const lastCursor = await collectionCallbacks.lastCursor?.(context, handle);
+            const lastCursor = await collectionCallbacks.lastCursor?.(context, identifier);
             const first = new URL(context.url);
             first.searchParams.set("cursor", firstCursor);
             let last = null;
@@ -109,7 +109,7 @@ export async function handleCollection(request, { name, handle, uriGetter, filte
     else {
         const uri = new URL(baseUri);
         uri.searchParams.set("cursor", cursor);
-        const page = await collectionCallbacks.dispatcher(context, handle, cursor, filter);
+        const page = await collectionCallbacks.dispatcher(context, identifier, cursor, filter);
         if (page == null)
             return await onNotFound(request);
         const { items, prevCursor, nextCursor } = page;
@@ -138,7 +138,7 @@ export async function handleCollection(request, { name, handle, uriGetter, filte
     if (collectionCallbacks.authorizePredicate != null) {
         const key = await context.getSignedKey();
         const keyOwner = await context.getSignedKeyOwner();
-        if (!await collectionCallbacks.authorizePredicate(context, handle, key, keyOwner)) {
+        if (!await collectionCallbacks.authorizePredicate(context, identifier, key, keyOwner)) {
             return await onUnauthorized(request);
         }
     }
@@ -175,16 +175,16 @@ function filterCollectionItems(items, collectionName, filterPredicate) {
     }
     return result;
 }
-export async function handleInbox(request, { handle, context, inboxContextFactory, kv, kvPrefixes, queue, actorDispatcher, inboxListeners, inboxErrorHandler, onNotFound, signatureTimeWindow, skipSignatureVerification, }) {
+export async function handleInbox(request, { identifier, context, inboxContextFactory, kv, kvPrefixes, queue, actorDispatcher, inboxListeners, inboxErrorHandler, onNotFound, signatureTimeWindow, skipSignatureVerification, }) {
     const logger = getLogger(["fedify", "federation", "inbox"]);
     if (actorDispatcher == null) {
-        logger.error("Actor dispatcher is not set.", { handle });
+        logger.error("Actor dispatcher is not set.", { identifier });
         return await onNotFound(request);
     }
-    else if (handle != null) {
-        const actor = await actorDispatcher(context, handle);
+    else if (identifier != null) {
+        const actor = await actorDispatcher(context, identifier);
         if (actor == null) {
-            logger.error("Actor {handle} not found.", { handle });
+            logger.error("Actor {identifier} not found.", { identifier });
             return await onNotFound(request);
         }
     }
@@ -193,7 +193,7 @@ export async function handleInbox(request, { handle, context, inboxContextFactor
         json = await request.clone().json();
     }
     catch (error) {
-        logger.error("Failed to parse JSON:\n{error}", { handle, error });
+        logger.error("Failed to parse JSON:\n{error}", { identifier, error });
         try {
             await inboxErrorHandler?.(context, error);
         }
@@ -238,11 +238,11 @@ export async function handleInbox(request, { handle, context, inboxContextFactor
     const jsonWithoutSig = detachSignature(json);
     let activity = null;
     if (ldSigVerified) {
-        logger.debug("Linked Data Signatures are verified.", { handle, json });
+        logger.debug("Linked Data Signatures are verified.", { identifier, json });
         activity = await Activity.fromJsonLd(jsonWithoutSig, context);
     }
     else {
-        logger.debug("Linked Data Signatures are not verified.", { handle, json });
+        logger.debug("Linked Data Signatures are not verified.", { identifier, json });
         try {
             activity = await verifyObject(Activity, jsonWithoutSig, {
                 contextLoader: context.contextLoader,
@@ -252,7 +252,7 @@ export async function handleInbox(request, { handle, context, inboxContextFactor
         }
         catch (error) {
             logger.error("Failed to parse activity:\n{error}", {
-                handle,
+                identifier,
                 json,
                 error,
             });
@@ -268,10 +268,10 @@ export async function handleInbox(request, { handle, context, inboxContextFactor
             });
         }
         if (activity == null) {
-            logger.debug("Object Integrity Proofs are not verified.", { handle, json });
+            logger.debug("Object Integrity Proofs are not verified.", { identifier, json });
         }
         else {
-            logger.debug("Object Integrity Proofs are verified.", { handle, json });
+            logger.debug("Object Integrity Proofs are verified.", { identifier, json });
         }
     }
     let httpSigKey = null;
@@ -284,7 +284,7 @@ export async function handleInbox(request, { handle, context, inboxContextFactor
                 keyCache,
             });
             if (key == null) {
-                logger.error("Failed to verify the request's HTTP Signatures.", { handle });
+                logger.error("Failed to verify the request's HTTP Signatures.", { identifier });
                 const response = new Response("Failed to verify the request signature.", {
                     status: 401,
                     headers: { "Content-Type": "text/plain; charset=utf-8" },
@@ -292,7 +292,7 @@ export async function handleInbox(request, { handle, context, inboxContextFactor
                 return response;
             }
             else {
-                logger.debug("HTTP Signatures are verified.", { handle });
+                logger.debug("HTTP Signatures are verified.", { identifier });
             }
             httpSigKey = key;
         }
@@ -339,7 +339,7 @@ export async function handleInbox(request, { handle, context, inboxContextFactor
             type: "inbox",
             baseUrl: request.url,
             activity: json,
-            handle,
+            identifier,
             attempt: 0,
             started: new Date().toISOString(),
         });