metadata: rename from @ndn/rdr

Author: yoursunny

package.json

@@ -13,7 +13,7 @@
     "test": "vitest",
     "typedoc": "bash mk/typedoc.sh"
   },
-  "packageManager": "pnpm@11.11.0+sha512.4463f65fd80ed80d69bc1d4bf163ee94f605c7380fc318bb5b2ebe15f8cd12d49c51a4d59e951b401e764d3b6ca751cbf51bc50ed7001a6bcb4935e684c34882",
+  "packageManager": "pnpm@11.17.0+sha512.cca3cea332ad254bb84145f966d19f4879615210346fc92c79a047f23a0d7b3cca3c3792f0076ba1f1831d277efbcf0a9119b31a9a60eca7fb3d6231f331ef72",
   "devDependencies": {
     "@types/node": "26.1.1",
     "@typescript/native": "npm:typescript@^7.0.2",

pkg/metadata/README.md

@@ -0,0 +1,5 @@
+# @ndn/metadata
+
+This package is part of [NDNts](https://yoursunny.com/p/NDNts/), Named Data Networking libraries for the modern web.
+
+This package implements the [Metadata Retrieval Protocol](https://redmine.named-data.net/projects/ndn-tlv/wiki/Metadata) (formerly RDR).

pkg/metadata/package.json

@@ -0,0 +1,40 @@
+{
+  "name": "@ndn/metadata",
+  "version": "0.0.20260427",
+  "description": "NDNts: Metadata Retrieval Protocol",
+  "keywords": [
+    "NDN",
+    "Named Data Networking"
+  ],
+  "author": "Junxiao Shi <npm@mail1.yoursunny.com>",
+  "license": "ISC",
+  "files": [
+    "lib"
+  ],
+  "type": "module",
+  "main": "src/mod.ts",
+  "module": "lib/mod_browser.js",
+  "sideEffects": false,
+  "homepage": "https://yoursunny.com/p/NDNts/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/yoursunny/NDNts.git",
+    "directory": "pkg/metadata"
+  },
+  "publishConfig": {
+    "main": "lib/mod_node.js",
+    "types": "lib/mod.d.ts"
+  },
+  "dependencies": {
+    "@ndn/endpoint": "workspace:*",
+    "@ndn/naming-convention2": "workspace:*",
+    "@ndn/packet": "workspace:*",
+    "@ndn/tlv": "workspace:*",
+    "tslib": "^2.8.1"
+  },
+  "devDependencies": {
+    "@ndn/fw": "workspace:^",
+    "@ndn/keychain": "workspace:*",
+    "@ndn/util": "workspace:*"
+  }
+}

pkg/rdr/src/consumer.ts pkg/metadata/src/consumer.tspkg/rdr/src/consumer.ts renamed to pkg/metadata/src/consumer.ts

@@ -18,24 +18,24 @@ export function makeDiscoveryInterest(prefix: NameLike): Interest {
 }
 
 /**
- * Retrieve metadata packet of base type.
+ * Retrieve metadata content of base type.
  * @param prefix - Metadata packet prefix.
  * @param cOpts - Consumer options.
  * - Commonly specified: `.retx` and `.verifier`.
- * - `.describe` defaults to "RDR-c" + prefix.
- * @returns Metadata packet.
+ * - `.describe` defaults to "metadata-c" + prefix.
+ * @returns Metadata content.
  */
 export async function retrieveMetadata(prefix: NameLike, cOpts?: ConsumerOptions): Promise<Metadata>;
 
 /**
- * Retrieve metadata packet of subclass type.
+ * Retrieve metadata content of subclass type.
  * @typeParam C - Metadata subclass type.
  * @param prefix - Metadata packet prefix.
  * @param ctor - Metadata subclass constructor.
  * @param cOpts - Consumer options.
  * - Commonly specified: `.retx` and `.verifier`.
- * - `.describe` defaults to "RDR-c" + prefix.
- * @returns Metadata packet of type C.
+ * - `.describe` defaults to "metadata-c" + prefix.
+ * @returns Metadata content of type C.
  */
 export async function retrieveMetadata<C extends Metadata.Constructor>(
   prefix: NameLike, ctor: C, cOpts?: ConsumerOptions
@@ -51,7 +51,7 @@ export async function retrieveMetadata(prefix: NameLike, arg2: any, cOpts?: Cons
 
   const interest = makeDiscoveryInterest(prefix);
   const data = await consume(interest, {
-    describe: `RDR-c(${prefix})`,
+    describe: `metadata-c(${prefix})`,
     ...cOpts,
   });
   return Decoder.decode(data.content, ctor);

pkg/rdr/src/metadata.ts pkg/metadata/src/metadata.tspkg/rdr/src/metadata.ts renamed to pkg/metadata/src/metadata.ts

@@ -0,0 +1,3 @@
+export * from "./metadata";
+export * from "./consumer";
+export * from "./producer";

pkg/metadata/src/mod.ts

@@ -10,7 +10,10 @@ function makeName({ name }: Metadata, prefix?: NameLike): Name {
   return prefix.append(MetadataKeyword, Version.create(Date.now()), Segment.create(0));
 }
 
-/** Make metadata packet. */
+/**
+ * Make metadata packet.
+ * @param m - Content of metadata packet.
+ */
 export async function makeMetadataPacket(m: Metadata, {
   prefix,
   freshnessPeriod = 1,
@@ -53,7 +56,11 @@ export function isDiscoveryInterest({ name, canBePrefix, mustBeFresh }: Interest
   return !!name.get(-1)?.equals(MetadataKeyword) && canBePrefix && mustBeFresh;
 }
 
-/** Serve metadata packet in a producer. */
+/**
+ * Serve metadata packet in a producer.
+ * @param m - Content of metadata packet, or a function that returns the content.
+ * @returns Producer instance.
+ */
 export function serveMetadata(m: Metadata | (() => Metadata), opts: serveMetadata.Options = {}): Producer {
   const {
     prefix: prefixInput,
@@ -74,7 +81,7 @@ export function serveMetadata(m: Metadata | (() => Metadata), opts: serveMetadat
       return undefined;
     },
     {
-      describe: `RDR-s(${prefix})`,
+      describe: `metadata-s(${prefix})`,
       ...pOpts,
     },
   );
@@ -85,7 +92,7 @@ export namespace serveMetadata {
      * Producer options.
      *
      * @remarks
-     * - `.describe` defaults to "RDR-s" + prefix.
+     * - `.describe` defaults to "metadata-s" + prefix.
      * - `.announcement` defaults to {@link makeMetadataPacket.Options.prefix}.
      * - {@link makeMetadataPacket.Options.signer} defaults to `.dataSigner`.
      */

pkg/rdr/src/producer.ts pkg/metadata/src/producer.tspkg/rdr/src/producer.ts renamed to pkg/metadata/src/producer.ts

@@ -2,4 +2,5 @@
 
 This package is part of [NDNts](https://yoursunny.com/p/NDNts/), Named Data Networking libraries for the modern web.
 
-This package implements metadata publishing and retrieval using [Realtime Data Retrieval (RDR) protocol](https://redmine.named-data.net/projects/ndn-tlv/wiki/RDR).
+*Realtime Data Retrieval (RDR) protocol* is renamed to [Metadata Retrieval Protocol](https://redmine.named-data.net/projects/ndn-tlv/wiki/Metadata).
+This package is deprecated in favor of `@ndn/metadata`.

pkg/rdr/tests/rdr.t.ts pkg/metadata/tests/rdr.t.tspkg/rdr/tests/rdr.t.ts renamed to pkg/metadata/tests/rdr.t.ts

@@ -26,15 +26,7 @@
     "types": "lib/mod.d.ts"
   },
   "dependencies": {
-    "@ndn/endpoint": "workspace:*",
-    "@ndn/naming-convention2": "workspace:*",
-    "@ndn/packet": "workspace:*",
-    "@ndn/tlv": "workspace:*",
+    "@ndn/metadata": "workspace:*",
     "tslib": "^2.8.1"
-  },
-  "devDependencies": {
-    "@ndn/fw": "workspace:^",
-    "@ndn/keychain": "workspace:*",
-    "@ndn/util": "workspace:*"
   }
 }