Replace url-template and uri-template-router with @fedify/uri-template

CHANGES.md

@@ -151,7 +151,13 @@ To be released.
     `http.response.status_code` and a richer
     `activitypub.lookup.result` taxonomy.  [[#316], [#738], [#771]]
 
+ -  Replaced Fedify's internal federation routing with
+    *@fedify/uri-template* for stricter RFC 6570 URI Template expansion and
+    matching.  The deprecated `Router` export from *@fedify/fedify* remains
+    available for compatibility.  [[#418], [#758] by ChanHaeng Lee]
+
 [#316]: https://github.com/fedify-dev/fedify/issues/316
+[#418]: https://github.com/fedify-dev/fedify/issues/418
 [#619]: https://github.com/fedify-dev/fedify/issues/619
 [#735]: https://github.com/fedify-dev/fedify/issues/735
 [#736]: https://github.com/fedify-dev/fedify/issues/736
@@ -164,6 +170,7 @@ To be released.
 [#753]: https://github.com/fedify-dev/fedify/pull/753
 [#755]: https://github.com/fedify-dev/fedify/pull/755
 [#757]: https://github.com/fedify-dev/fedify/pull/757
+[#758]: https://github.com/fedify-dev/fedify/pull/758
 [#759]: https://github.com/fedify-dev/fedify/pull/759
 [#769]: https://github.com/fedify-dev/fedify/pull/769
 [#770]: https://github.com/fedify-dev/fedify/pull/770
@@ -180,6 +187,13 @@ To be released.
  -  Added a `meterProvider` option to `createFederation()` so mock contexts can
     expose a test OpenTelemetry meter provider.  [[#316], [#619], [#755]]
 
+### @fedify/uri-template
+
+ -  Added *@fedify/uri-template*, a dependency-free RFC 6570 URI Template
+    implementation for expansion, variable extraction, and round-trip route
+    matching.  This package replaces Fedify's previous direct use of
+    *url-template* and *uri-template-router*.  [[#418], [#758] by ChanHaeng Lee]
+
 ### @fedify/amqp
 
  -  Added `AmqpMessageQueue.getDepth()` for reporting queued, ready, and

cspell.json

@@ -30,9 +30,11 @@
     "docloader",
     "dotenvx",
     "draft-cavage",
+    "duplicable",
     "eddsa",
     "elysia",
     "elysiajs",
+    "explodable",
     "fanout",
     "federatable",
     "Federatable",
@@ -79,6 +81,7 @@
     "nodeinfo",
     "nuxi",
     "nuxt",
+    "operatables",
     "optique",
     "phensley",
     "Pico",
@@ -88,6 +91,7 @@
     "popd",
     "poppanator",
     "precommand",
+    "prefixable",
     "proto",
     "pushd",
     "pwsh",
@@ -121,6 +125,11 @@
     "urlpattern",
     "uuidv7",
     "valueparser",
+    "varspec",
+    "varname",
+    "varnames",
+    "varchar",
+    "varchars",
     "Vinxi",
     "vitepress",
     "vtsls",

deno.json

@@ -25,6 +25,7 @@
     "./packages/sqlite",
     "./packages/sveltekit",
     "./packages/testing",
+    "./packages/uri-template",
     "./packages/vocab",
     "./packages/vocab-runtime",
     "./packages/vocab-tools",

docs/manual/actor.md

@@ -98,10 +98,13 @@ should fall through to the next middleware or `onNotFound` handler.
 
 > [!NOTE]
 > The URI Template syntax supports different expansion types like `{identifier}`
-> (simple expansion) and `{+identifier}` (reserved expansion).  Choosing the
-> right expansion type is important to avoid encoding issues.  See the
-> [*URI Template* guide](./uri-template.md) for details on when to use
-> each type.
+> (simple expansion) and `{+identifier}` (reserved expansion).  Use the plain
+> `{identifier}` form for ordinary segment-bounded identifiers such as
+> `/users/{identifier}`.  `{+identifier}` is an advanced choice reserved for
+> identifiers that themselves contain slashes (such as embedded URIs); because
+> it keeps `/` literal, it can consume extra path segments and overlap with
+> more specific routes.  See the [*URI Template* guide](./uri-template.md) for
+> details on when to use each type.
 
 [actors]: https://www.w3.org/TR/activitystreams-core/#actors
 [activities]: https://www.w3.org/TR/activitystreams-core/#activities

docs/manual/collections.md

@@ -53,9 +53,12 @@ follows the [URI Template] specification.
 
 > [!NOTE]
 > The URI Template syntax supports different expansion types like `{identifier}`
-> (simple expansion) and `{+identifier}` (reserved expansion).  If your
-> identifiers contain URIs or special characters, you may need to use
-> `{+identifier}` to avoid double-encoding issues.  See the
+> (simple expansion) and `{+identifier}` (reserved expansion).  Use the plain
+> `{identifier}` form for ordinary segment-bounded identifiers; `{+identifier}`
+> is an advanced choice reserved for identifiers that themselves contain
+> slashes (such as embedded URIs), since it keeps `/` literal and can consume
+> extra path segments.  Note that a writable outbox is further restricted to
+> the strict `{identifier}` shape and rejects `{+identifier}`.  See the
 > [*URI Template* guide](./uri-template.md) for details.
 
 Since the outbox is a collection of activities, the outbox dispatcher should

docs/manual/inbox.md

@@ -182,10 +182,13 @@ multiple inbox listeners for different activity types.
 
 > [!NOTE]
 > The URI Template syntax supports different expansion types like `{identifier}`
-> (simple expansion) and `{+identifier}` (reserved expansion).  If your
-> identifiers contain URIs or special characters, you may need to use
-> `{+identifier}` to avoid double-encoding issues.  See the
-> [*URI Template* guide](./uri-template.md) for details.
+> (simple expansion) and `{+identifier}` (reserved expansion).  Use the plain
+> `{identifier}` form for ordinary segment-bounded identifiers such as
+> `/users/{identifier}/inbox`.  `{+identifier}` is an advanced choice reserved
+> for identifiers that themselves contain slashes (such as embedded URIs);
+> because it keeps `/` literal, it can consume extra path segments and overlap
+> with more specific routes, so add explicit validation when you use it.  See
+> the [*URI Template* guide](./uri-template.md) for details.
 
 > [!WARNING]
 > Activities of any type that are not registered with

docs/manual/outbox.md

@@ -79,9 +79,14 @@ actor who owns the addressed outbox.
 > [!NOTE]
 > The URI Template syntax supports different expansion types like
 > `{identifier}` (simple expansion) and `{+identifier}` (reserved expansion).
-> If your identifiers contain URIs or special characters, you may need to use
-> `{+identifier}` to avoid double-encoding issues.  See the
-> [*URI Template* guide][uri-template-guide] for details.
+> Use the plain `{identifier}` form for ordinary segment-bounded identifiers;
+> `{+identifier}` is an advanced choice reserved for identifiers that
+> themselves contain slashes (such as embedded URIs).  The outbox is
+> additionally restricted: both `~Federatable.setOutboxDispatcher()` and
+> `~Federatable.setOutboxListeners()` require the strict single-segment
+> `{identifier}` shape and reject `{+identifier}` at registration time, so a
+> writable (or read-only) outbox cannot use reserved expansion.  See
+> the [*URI Template* guide][uri-template-guide] for details.
 
 [uri-template-guide]: ./uri-template.md