feat: add blob support to query

Author: kitsonk

CHANGELOG.md

@@ -71,11 +71,10 @@
 
 - feat: make sizeOf public (738b6bf)
 
-  `sizeOf()` was previously just internal, but it is generally useful when
-  working with Deno KV to be able to estimate the size of keys and values. The
-  Deno KV documentation currently suggests using the length of
-  `JSON.stringify()` string, which can be very problematic when dealing with
-  complex values that don't serialize to JSON but are storable in Deno KV.
+  `sizeOf()` was previously just internal, but it is generally useful when working with Deno KV to be able to estimate
+  the size of keys and values. The Deno KV documentation currently suggests using the length of `JSON.stringify()`
+  string, which can be very problematic when dealing with complex values that don't serialize to JSON but are storable
+  in Deno KV.
 
 ## Version 0.20.1
 
@@ -85,10 +84,9 @@
 
 - feat: arrays, objects, maps and sets are deeply serialized (bf8f285)
 
-  Previously only value supported by JSON directly were serialized as values and
-  keys of arrays, objects, maps and sets. While kv-toolbox can deserialize the
-  old format, it supports a new JSON format that allows all value supported by
-  Deno KV to be properly serialized and deserialized.
+  Previously only value supported by JSON directly were serialized as values and keys of arrays, objects, maps and sets.
+  While kv-toolbox can deserialize the old format, it supports a new JSON format that allows all value supported by Deno
+  KV to be properly serialized and deserialized.
 
 - docs: update changelog (38bd7cd)
 
@@ -141,29 +139,25 @@
 
 - feat: re-work batching for batchedAtomic to align to current Deno KV (e3c8136)
 
-  `batchedAtomic()` now aligns to current versions of Deno KV in how it decides
-  where to _segment_ atomic transactions. Because of the much higher increases
-  users should consider only using `batchedAtomic()` when dealing with
-  potentially large transactions where potentially failing due to the size
-  restriction is awkward or difficult.
+  `batchedAtomic()` now aligns to current versions of Deno KV in how it decides where to _segment_ atomic transactions.
+  Because of the much higher increases users should consider only using `batchedAtomic()` when dealing with potentially
+  large transactions where potentially failing due to the size restriction is awkward or difficult.
 
 - feat: align blob set and get to Deno.Kv APIs (923faf1)
 
-  **BREAKING** Previously `set()` resolved with void and `get()` resolved with a
-  value or `null`. In addition, `getMeta()` resolved with a value.
+  **BREAKING** Previously `set()` resolved with void and `get()` resolved with a value or `null`. In addition,
+  `getMeta()` resolved with a value.
 
-  Now `set()` resolves with a `Deno.KvCommitResult` and `get()` and `getMeta()`
-  resolve with a `Deno.KvEntryMaybe` with the appropriate type.
+  Now `set()` resolves with a `Deno.KvCommitResult` and `get()` and `getMeta()` resolve with a `Deno.KvEntryMaybe` with
+  the appropriate type.
 
 - feat: add support for checking blobs in batched_atomic (389730a)
 
-  `batchedAtomic()` transactions now support `.checkBlob()` checks as part of an
-  atomic transaction.
+  `batchedAtomic()` transactions now support `.checkBlob()` checks as part of an atomic transaction.
 
 - feat: add `getAsResponse()` to blob (796ed64)
 
-  `getAsResponse()` will retrieve a blob entry as a `Response` which will stream
-  the blob from the store to a client.
+  `getAsResponse()` will retrieve a blob entry as a `Response` which will stream the blob from the store to a client.
 
 - chore: linting in blob_util (bd6b888)
 - docs: update readme about batchAtomic (bca0fb6)

README.md

@@ -1,11 +1,4 @@
-import {
-  assert,
-  assertEquals,
-  assertNotEquals,
-  delay,
-  setup,
-  teardown,
-} from "./_test_util.ts";
+import { assert, assertEquals, assertNotEquals, delay, setup, teardown } from "./_test_util.ts";
 import { keys } from "./keys.ts";
 
 import { batchedAtomic } from "./batched_atomic.ts";

batched_atomic.test.ts

@@ -307,9 +307,7 @@ export class BatchedAtomicOperation {
           // if there are multiple mutations, we need to batch them
           if (args.length > 1) {
             this.#queue.unshift(
-              ...args.map((mutation) =>
-                [method, [mutation]] as [AtomicOperationKeys, unknown[]]
-              ),
+              ...args.map((mutation) => [method, [mutation]] as [AtomicOperationKeys, unknown[]]),
             );
             continue;
           } else {

batched_atomic.ts

@@ -1,12 +1,4 @@
-import {
-  assert,
-  assertEquals,
-  assertRejects,
-  assertThrows,
-  setup,
-  teardown,
-  timingSafeEqual,
-} from "./_test_util.ts";
+import { assert, assertEquals, assertRejects, assertThrows, setup, teardown, timingSafeEqual } from "./_test_util.ts";
 
 import {
   get,

blob.test.ts

@@ -189,9 +189,7 @@ async function asJSON(
 }
 
 function toParts(blob: ArrayBufferLike | ArrayBufferView): string[] {
-  const buffer = ArrayBuffer.isView(blob)
-    ? new Uint8Array(blob.buffer)
-    : new Uint8Array(blob);
+  const buffer = ArrayBuffer.isView(blob) ? new Uint8Array(blob.buffer) : new Uint8Array(blob);
   const parts: string[] = [];
   let offset = 0;
   while (buffer.byteLength > offset) {
@@ -539,13 +537,7 @@ export function list(
   if ([stream, blob, bytes, meta].filter(Boolean).length > 1) {
     throw new TypeError("Cannot set multiple value types as once.");
   }
-  const valueKind = stream
-    ? "stream"
-    : blob
-    ? "blob"
-    : bytes
-    ? "bytes"
-    : "meta";
+  const valueKind = stream ? "stream" : blob ? "blob" : bytes ? "bytes" : "meta";
   return new BlobListIterator(kv, selector, options, valueKind);
 }
 
@@ -704,8 +696,7 @@ export async function getAsResponse(
     });
   }
   const headers = new Headers(options.headers);
-  const contentType =
-    (maybeMeta.value.kind !== "buffer" && maybeMeta.value.type) ||
+  const contentType = (maybeMeta.value.kind !== "buffer" && maybeMeta.value.type) ||
     "application/octet-stream";
   headers.set("content-type", contentType);
   if (maybeMeta.value.size) {

blob.ts

@@ -327,11 +327,10 @@ export async function removeBlob(kv: Deno.Kv, key: Deno.KvKey) {
 
 const AsyncIterator = Object.getPrototypeOf(async function* () {}).constructor;
 
-export class BlobListIterator extends AsyncIterator
-  implements
-    Deno.KvListIterator<
-      BlobMeta | Uint8Array | Blob | File | ReadableStream<Uint8Array>
-    > {
+export class BlobListIterator extends AsyncIterator implements
+  Deno.KvListIterator<
+    BlobMeta | Uint8Array | Blob | File | ReadableStream<Uint8Array>
+  > {
   #iterator: Deno.KvListIterator<unknown>;
   #count = 0;
   #kv: Deno.Kv;

blob_util.ts

@@ -1,10 +1,4 @@
-import {
-  assert,
-  assertEquals,
-  setup,
-  teardown,
-  timingSafeEqual,
-} from "./_test_util.ts";
+import { assert, assertEquals, setup, teardown, timingSafeEqual } from "./_test_util.ts";
 
 import { CryptoKv, generateKey } from "./crypto.ts";
 
@@ -31,8 +25,7 @@ Deno.test({
     const kv = await setup();
     const key = generateKey();
     const cryptoKv = new CryptoKv(kv, key);
-    const value =
-      globalThis.crypto.getRandomValues(new Uint8Array(65_536)).buffer;
+    const value = globalThis.crypto.getRandomValues(new Uint8Array(65_536)).buffer;
     const res = await cryptoKv.setBlob(["example"], value);
     assert(res.ok);
     const actual = await cryptoKv.getBlob(["example"]);

crypto.test.ts

@@ -37,13 +37,7 @@ import { concat } from "@std/bytes/concat";
 
 import { batchedAtomic } from "./batched_atomic.ts";
 import { BLOB_KEY, type BlobJSON, type BlobMeta, toJSON } from "./blob.ts";
-import {
-  asMeta,
-  asUint8Array,
-  BATCH_SIZE,
-  removeBlob,
-  setBlob,
-} from "./blob_util.ts";
+import { asMeta, asUint8Array, BATCH_SIZE, removeBlob, setBlob } from "./blob_util.ts";
 import { keys } from "./keys.ts";
 
 /** Valid data types that can be used when supplying an encryption key. */

crypto.ts

@@ -27,9 +27,7 @@
     "test:ci": "deno test --allow-read --allow-write --unstable-kv --junit-path=junit.xml --coverage=./cov --parallel"
   },
   "lock": false,
-  "format": {
-    "lineWidth": 120
-  },
+  "fmt": { "lineWidth": 120 },
   "imports": {
     "@deno/kv-utils": "jsr:@deno/kv-utils@^0.1.3",
     "@std/assert": "jsr:@std/assert@~1",