feat: add support for import/exporting NDJSON

Author: kitsonk

README.md

@@ -113,6 +113,38 @@ Deserialize a JSON structure to a value which can be stored in a Deno KV store.
 Serialize a value which has been stored in a Deno KV store into a structure
 which can be safely converted to a JSON string.
 
+## NDJSON
+
+New line delimitated JSON ([NDJSON](https://github.com/ndjson/ndjson-spec)) is a
+standard for supporting JSON string encoding of data where each record of data
+is delimitated by a new line. This particular format is the most straight-
+forward way of supporting JSON encoding and streaming.
+
+The toolbox includes the capabilities to export entries from a KV store to
+NDJSON, transform a byte stream of NDJSON into individual JSON KV entry
+representations, and be able to import KV entries from NDJSON encoded data.
+
+### `exportEntries()`
+
+Like `Deno.Kv.prototype.list()`, but entries are returned as a stream of bytes
+or strings encoded as NDJSON.
+
+### `exportToResponse()`
+
+Like `Deno.Kv.prototype.list()`, but a `Response` is returned with the selected
+entries encoded as NDJSON as the body of the response, suitable for sending to a
+client as a response to a query.
+
+### `LineTransformStream()`
+
+A transform stream which takes a byte stream, like from a `Request` body, of
+NDJSON encoded entry data and transforms it into individual chunks of JSON
+strings which can be used with `JSON.parse()`.
+
+### `importEntries()`
+
+Takes NDJSON encoded data and imports it into a Deno KV store.
+
 ## Keys
 
 APIs for dealing with Deno KV keys.

_test_util.ts

@@ -1,12 +1,11 @@
-import { assert } from "https://deno.land/[email protected]/assert/assert.ts";
-export { delay } from "https://deno.land/[email protected]/async/delay.ts";
-export { assert } from "https://deno.land/[email protected]/assert/assert.ts";
-export { assertEquals } from "https://deno.land/[email protected]/assert/assert_equals.ts";
-export {
-  assertNotEquals,
-} from "https://deno.land/[email protected]/assert/assert_not_equals.ts";
-export { assertStrictEquals } from "https://deno.land/[email protected]/assert/assert_strict_equals.ts";
-export { timingSafeEqual } from "https://deno.land/[email protected]/crypto/timing_safe_equal.ts";
+import { assert } from "jsr:@std/[email protected]/assert";
+export { concat } from "jsr:@std/[email protected]/concat";
+export { delay } from "jsr:@std/[email protected]/delay";
+export { assert } from "jsr:@std/[email protected]/assert";
+export { assertEquals } from "jsr:@std/[email protected]/assert_equals";
+export { assertNotEquals } from "jsr:@std/[email protected]/assert_not_equals";
+export { assertStrictEquals } from "jsr:@std/[email protected]/assert_strict_equals";
+export { timingSafeEqual } from "jsr:@std/[email protected]/timing_safe_equal";
 
 let kv: Deno.Kv | undefined;
 let path: string | undefined;

deno.json

@@ -5,7 +5,8 @@
     "./batched_atomic": "./batched_atomic.ts",
     "./blob": "./blob.ts",
     "./json": "./json.ts",
-    "./keys": "./keys.ts"
+    "./keys": "./keys.ts",
+    "./ndjson": "./ndjson.ts"
   },
   "tasks": {
     "coverage": "deno coverage --lcov --output=cov.lcov ./cov",

json.ts

@@ -37,7 +37,7 @@
 import {
   decodeBase64Url,
   encodeBase64Url,
-} from "https://deno.land/[email protected].2/encoding/base64url.ts";
+} from "jsr:@std/encoding@0.218/base64url";
 
 // Deno KV Key types
 

keys.ts

@@ -144,7 +144,7 @@
  * @module
  */
 
-import { timingSafeEqual } from "https://deno.land/[email protected].2/crypto/timing_safe_equal.ts";
+import { timingSafeEqual } from "jsr:@std/crypto@0.218/timing_safe_equal";
 
 function addIfUnique(set: Set<Deno.KvKeyPart>, item: Uint8Array) {
   for (const i of set) {