@fedify/fedify 0.11.0-dev.229 → 0.11.0-dev.234

package/CHANGES.md

@@ -8,6 +8,10 @@ Version 0.11.0
 
 To be released.
 
+ -  Improved runtime type error messages for Activity Vocabulary API.  [[#79]]
+
+ -  Added `Federation.setInboxDispatcher()` method.  [[#71]]
+
  -  Frequently used JSON-LD contexts are now preloaded.  [[74]]
 
      -  The `fetchDocumentLoader()` function now preloads the following JSON-LD
@@ -25,8 +29,10 @@ To be released.
  -  Added `Offer` class to Activity Vocabulary API.
     [[#65], [#76] by Lee Dogeon]
 
+[#71]: https://github.com/dahlia/fedify/issues/71
 [#74]: https://github.com/dahlia/fedify/issues/74
 [#76]: https://github.com/dahlia/fedify/pull/76
+[#79]: https://github.com/dahlia/fedify/issues/79
 
 
 Version 0.10.0

package/esm/federation/middleware.js

@@ -42,6 +42,8 @@ export class Federation {
     #actorCallbacks;
     #objectCallbacks;
     #objectTypeIds;
+    #inboxPath;
+    #inboxCallbacks;
     #outboxCallbacks;
     #followingCallbacks;
     #followersCallbacks;
@@ -79,7 +81,6 @@ export class Federation {
         this.#router = new Router();
         this.#router.add("/.well-known/webfinger", "webfinger");
         this.#router.add("/.well-known/nodeinfo", "nodeInfoJrd");
-        this.#inboxListeners = new Map();
         this.#objectCallbacks = {};
         this.#objectTypeIds = {};
         this.#documentLoader = options.documentLoader ?? kvCache({
@@ -405,6 +406,58 @@ export class Federation {
         };
         return setters;
     }
+    /**
+     * Registers an inbox dispatcher.
+     *
+     * @param path The URI path pattern for the outbox dispatcher.  The syntax is
+     *             based on URI Template
+     *             ([RFC 6570](https://tools.ietf.org/html/rfc6570)).  The path
+     *             must have one variable: `{handle}`, and must match the inbox
+     *             listener path.
+     * @param dispatcher An inbox dispatcher callback to register.
+     * @throws {@link RouterError} Thrown if the path pattern is invalid.
+     * @since 0.11.0
+     */
+    setInboxDispatcher(path, dispatcher) {
+        if (this.#inboxCallbacks != null) {
+            throw new RouterError("Inbox dispatcher already set.");
+        }
+        if (this.#router.has("inbox")) {
+            if (this.#inboxPath !== path) {
+                throw new RouterError("Inbox dispatcher path must match inbox listener path.");
+            }
+        }
+        else {
+            const variables = this.#router.add(path, "inbox");
+            if (variables.size !== 1 || !variables.has("handle")) {
+                throw new RouterError("Path for inbox dispatcher must have one variable: {handle}");
+            }
+            this.#inboxPath = path;
+        }
+        const callbacks = {
+            dispatcher,
+        };
+        this.#inboxCallbacks = 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;
+    }
     /**
      * Registers an outbox dispatcher.
      *
@@ -567,7 +620,8 @@ export class Federation {
      * @param inboxPath The URI path pattern for the inbox.  The syntax is based
      *                  on URI Template
      *                  ([RFC 6570](https://tools.ietf.org/html/rfc6570)).
-     *                  The path must have one variable: `{handle}`.
+     *                  The path must have one variable: `{handle}`, and must
+     *                  match the inbox dispatcher path.
      * @param sharedInboxPath An optional URI path pattern for the shared inbox.
      *                        The syntax is based on URI Template
      *                        ([RFC 6570](https://tools.ietf.org/html/rfc6570)).
@@ -576,12 +630,19 @@ export class Federation {
      * @throws {RouteError} Thrown if the path pattern is invalid.
      */
     setInboxListeners(inboxPath, sharedInboxPath) {
+        if (this.#inboxListeners != null) {
+            throw new RouterError("Inbox listeners already set.");
+        }
         if (this.#router.has("inbox")) {
-            throw new RouterError("Inbox already set.");
+            if (this.#inboxPath !== inboxPath) {
+                throw new RouterError("Inbox listener path must match inbox dispatcher path.");
+            }
         }
-        const variables = this.#router.add(inboxPath, "inbox");
-        if (variables.size !== 1 || !variables.has("handle")) {
-            throw new RouterError("Path for inbox must have one variable: {handle}");
+        else {
+            const variables = this.#router.add(inboxPath, "inbox");
+            if (variables.size !== 1 || !variables.has("handle")) {
+                throw new RouterError("Path for inbox must have one variable: {handle}");
+            }
         }
         if (sharedInboxPath != null) {
             const siVars = this.#router.add(sharedInboxPath, "sharedInbox");
@@ -589,7 +650,7 @@ export class Federation {
                 throw new RouterError("Path for shared inbox must have no variables.");
             }
         }
-        const listeners = this.#inboxListeners;
+        const listeners = this.#inboxListeners = new Map();
         const setter = {
             on(
             // deno-lint-ignore no-explicit-any
@@ -790,6 +851,17 @@ export class Federation {
                     onNotAcceptable,
                 });
             case "inbox":
+                if (request.method !== "POST") {
+                    return await handleCollection(request, {
+                        name: "inbox",
+                        handle: route.values.handle,
+                        context,
+                        collectionCallbacks: this.#inboxCallbacks,
+                        onUnauthorized,
+                        onNotFound,
+                        onNotAcceptable,
+                    });
+                }
                 context = this.#createContext(request, contextData, {
                     documentLoader: await context.getDocumentLoader({
                         handle: route.values.handle,
@@ -803,7 +875,7 @@ export class Federation {
                     kv: this.#kv,
                     kvPrefix: this.#kvPrefixes.activityIdempotence,
                     actorDispatcher: this.#actorCallbacks?.dispatcher,
-                    inboxListeners: this.#inboxListeners,
+                    inboxListeners: this.#inboxListeners ?? new Map(),
                     inboxErrorHandler: this.#inboxErrorHandler,
                     onNotFound,
                     signatureTimeWindow: this.#signatureTimeWindow,