[FEAT] [KV] expose stream metadata

jetstream/kv.ts

@@ -263,6 +263,9 @@ export class Bucket implements KV, KvRemove {
     } else {
       sc.subjects = [this.subjectForBucket()];
     }
+    if (opts.metadata) {
+      sc.metadata = opts.metadata;
+    }
 
     const nci = (this.js as unknown as { nc: NatsConnectionImpl }).nc;
     const have = nci.getServerVersion();
@@ -917,6 +920,10 @@ export class KvStatusImpl implements KvStatus {
   get size(): number {
     return this.si.state.bytes;
   }
+
+  get metadata(): Record<string, string> {
+    return this.si.config.metadata ?? {};
+  }
 }
 
 class KvStoredEntryImpl implements KvEntry {

jetstream/tests/kv_test.ts

@@ -1767,3 +1767,16 @@ Deno.test("kv - string payloads", async () => {
 
   await cleanup(ns, nc);
 });
+
+Deno.test("kv - metadata", async () => {
+  const { ns, nc } = await setup(jetstreamServerConf({}, true));
+  if (await notCompatible(ns, nc, "2.10.0")) {
+    return;
+  }
+
+  const js = nc.jetstream();
+  const kv = await js.views.kv("K", { metadata: { hello: "world" } });
+  const status = await kv.status();
+  assertEquals(status.metadata?.hello, "world");
+  await cleanup(ns, nc);
+});

jetstream/types.ts

@@ -1030,6 +1030,12 @@ export interface KvStatus extends KvLimits {
    * Size of the bucket in bytes
    */
   size: number;
+  /**
+   * Metadata field to store additional information about the stream. Note that
+   * keys starting with `_nats` are reserved. This feature only supported on servers
+   * 2.10.x and better.
+   */
+  metadata?: Record<string, string>;
 }
 
 export interface KvOptions extends KvLimits {
@@ -1055,6 +1061,12 @@ export interface KvOptions extends KvLimits {
    * but has the possibility of inconsistency during a read.
    */
   allow_direct: boolean;
+  /**
+   * Metadata field to store additional information about the kv. Note that
+   * keys starting with `_nats` are reserved. This feature only supported on servers
+   * 2.10.x and better.
+   */
+  metadata?: Record<string, string>;
 }
 
 /**