feat: expose API.Kv* types

Author: jviide

.changeset/tired-teams-jam.md

@@ -0,0 +1,5 @@
+---
+"@badrap/libapp": patch
+---
+
+Expose API.Kv\* types

src/api/index.ts

@@ -1,6 +1,7 @@
 import * as v from "@badrap/valita";
 import { HTTPError, APIError, Client, type ClientConfig } from "./client.ts";
 import { Kv } from "./kv.ts";
+import type * as KvTypes from "./kv.ts";
 
 export { HTTPError, APIError };
 
@@ -269,3 +270,29 @@ export class API<
     });
   }
 }
+
+export declare namespace API {
+  export type Kv = KvTypes.Kv;
+
+  export type KvKey = KvTypes.KvKey;
+
+  export type KvEntry<T> = KvTypes.KvEntry<T>;
+
+  export type KvEntryMaybe<T> = KvTypes.KvEntryMaybe<T>;
+
+  export type KvCheck = KvTypes.KvCheck;
+
+  export type KvMutation = KvTypes.KvMutation;
+
+  export type KvCommitResult = KvTypes.KvCommitResult;
+
+  export type KvCommitError = KvTypes.KvCommitError;
+
+  export type KvListSelector = KvTypes.KvListSelector;
+
+  export type KvListOptions = KvTypes.KvListOptions;
+
+  export type KvListIterator<T> = KvTypes.KvListIterator<T>;
+
+  export type KvAtomicOperation = KvTypes.KvAtomicOperation;
+}

src/api/kv.ts

@@ -1,17 +1,17 @@
 import * as v from "@badrap/valita";
 import { type Client, HTTPError } from "./client.ts";
 
-type KvKey = (number | string | boolean)[];
+export type KvKey = (number | string | boolean)[];
 
-type KvEntry<T> = { key: KvKey; value: T; versionstamp: string };
+export type KvEntry<T> = { key: KvKey; value: T; versionstamp: string };
 
-type KvEntryMaybe<T> =
+export type KvEntryMaybe<T> =
   | KvEntry<T>
   | { key: KvKey; value: null; versionstamp: null };
 
-type AtomicCheck = { key: KvKey; versionstamp: string | null };
+export type KvCheck = { key: KvKey; versionstamp: string | null };
 
-type KvMutation =
+export type KvMutation =
   | {
       type: "set";
       key: KvKey;
@@ -31,19 +31,23 @@ type KvMutation =
       backoffSchedule?: number[];
     };
 
-type KvCommitResult = { ok: true; versionstamp: string };
+export type KvCommitResult = { ok: true; versionstamp: string };
 
-type KvCommitError = { ok: false };
+export type KvCommitError = { ok: false };
 
-type KvListSelector =
+export type KvListSelector =
   | { prefix: KvKey; start?: undefined; end?: undefined }
   | { prefix: KvKey; start: KvKey; end?: undefined }
   | { prefix: KvKey; start?: undefined; end: KvKey }
   | { prefix?: undefined; start: KvKey; end: KvKey };
 
-type KvListOptions = { limit?: number; reverse?: boolean; batchSize?: number };
+export type KvListOptions = {
+  limit?: number;
+  reverse?: boolean;
+  batchSize?: number;
+};
 
-type KvListIterator<T> = AsyncIterableIterator<KvEntry<T>>;
+export type KvListIterator<T> = AsyncIterableIterator<KvEntry<T>>;
 
 const Key = v.array(v.union(v.string(), v.number(), v.boolean()));
 
@@ -155,21 +159,21 @@ export class Kv {
     }
   }
 
-  atomic(): AtomicOperation {
-    return new AtomicOperation(this.#client);
+  atomic(): KvAtomicOperation {
+    return new KvAtomicOperation(this.#client);
   }
 }
 
-class AtomicOperation {
+export class KvAtomicOperation {
   readonly #client: Client;
-  readonly #checks: AtomicCheck[] = [];
+  readonly #checks: KvCheck[] = [];
   readonly #mutations: KvMutation[] = [];
 
   constructor(client: Client) {
     this.#client = client;
   }
 
-  check(...checks: AtomicCheck[]): this {
+  check(...checks: KvCheck[]): this {
     for (const { key, versionstamp } of checks) {
       this.#checks.push({ key, versionstamp });
     }