@aztec/kv-store 0.86.0-nightly.20250513 → 0.86.0-nightly.20250514

package/dest/interfaces/common.d.ts

@@ -1,12 +1,8 @@
-/**
- * The key type for use with the kv-store
- */
-export type Key = string | number | Array<string | number>;
+/** The key type for use with the kv-store */
+export type Key = string | number | Uint8Array | Array<string | number>;
 export type Value = NonNullable<any>;
-/**
- * A range of keys to iterate over.
- */
-export type Range<K extends Key = Key> = {
+/** A range of keys of arbitrary type. */
+export type CustomRange<K> = {
     /** The key of the first item to include */
     start?: K;
     /** The key of the last item to include */
@@ -16,6 +12,10 @@ export type Range<K extends Key = Key> = {
     /** The maximum number of items to iterate over */
     limit?: number;
 };
+/** Maps a custom range into a range of valid key types to iterate over. */
+export declare function mapRange<CK, K extends Key = Key>(range: CustomRange<CK>, mapFn: (key: CK) => K): Range<K>;
+/** A range of keys to iterate over. */
+export type Range<K extends Key = Key> = CustomRange<K>;
 export type StoreSize = {
     mappingSize: number;
     physicalFileSize: number;

package/dest/interfaces/common.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/interfaces/common.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAE3D,MAAM,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;AAErC;;GAEG;AACH,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI;IACvC,2CAA2C;IAC3C,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,0CAA0C;IAC1C,GAAG,CAAC,EAAE,CAAC,CAAC;IACR,oCAAoC;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC"}
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/interfaces/common.ts"],"names":[],"mappings":"AAAA,6CAA6C;AAC7C,MAAM,MAAM,GAAG,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,GAAG,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,CAAC;AAExE,MAAM,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,CAAC,CAAC;AAErC,yCAAyC;AACzC,MAAM,MAAM,WAAW,CAAC,CAAC,IAAI;IAC3B,2CAA2C;IAC3C,KAAK,CAAC,EAAE,CAAC,CAAC;IACV,0CAA0C;IAC1C,GAAG,CAAC,EAAE,CAAC,CAAC;IACR,oCAAoC;IACpC,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kDAAkD;IAClD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,2EAA2E;AAC3E,wBAAgB,QAAQ,CAAC,EAAE,EAAE,CAAC,SAAS,GAAG,GAAG,GAAG,EAAE,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,EAAE,EAAE,KAAK,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAOzG;AAED,uCAAuC;AACvC,MAAM,MAAM,KAAK,CAAC,CAAC,SAAS,GAAG,GAAG,GAAG,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;AAExD,MAAM,MAAM,SAAS,GAAG;IAAE,WAAW,EAAE,MAAM,CAAC;IAAC,gBAAgB,EAAE,MAAM,CAAC;IAAC,UAAU,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,CAAC"}

package/dest/interfaces/common.js

@@ -1,3 +1,8 @@
-/**
- * The key type for use with the kv-store
- */ export { };
+/** The key type for use with the kv-store */ /** Maps a custom range into a range of valid key types to iterate over. */ export function mapRange(range, mapFn) {
+    return {
+        start: range.start ? mapFn(range.start) : undefined,
+        end: range.end ? mapFn(range.end) : undefined,
+        reverse: range.reverse,
+        limit: range.limit
+    };
+}

package/dest/interfaces/index.d.ts

@@ -5,5 +5,6 @@ export * from './singleton.js';
 export * from './store.js';
 export * from './set.js';
 export * from './multi_map.js';
-export type { Range, StoreSize } from './common.js';
+export { mapRange } from './common.js';
+export type { CustomRange, Range, StoreSize } from './common.js';
 //# sourceMappingURL=index.d.ts.map

package/dest/interfaces/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,YAAY,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/interfaces/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,cAAc,CAAC;AAC7B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC;AAC3B,cAAc,UAAU,CAAC;AACzB,cAAc,gBAAgB,CAAC;AAC/B,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,YAAY,EAAE,WAAW,EAAE,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC"}

package/dest/interfaces/index.js

@@ -5,3 +5,4 @@ export * from './singleton.js';
 export * from './store.js';
 export * from './set.js';
 export * from './multi_map.js';
+export { mapRange } from './common.js';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aztec/kv-store",
-  "version": "0.86.0-nightly.20250513",
+  "version": "0.86.0-nightly.20250514",
   "type": "module",
   "exports": {
     ".": "./dest/interfaces/index.js",
@@ -23,10 +23,10 @@
     "./package.local.json"
   ],
   "dependencies": {
-    "@aztec/ethereum": "0.86.0-nightly.20250513",
-    "@aztec/foundation": "0.86.0-nightly.20250513",
-    "@aztec/native": "0.86.0-nightly.20250513",
-    "@aztec/stdlib": "0.86.0-nightly.20250513",
+    "@aztec/ethereum": "0.86.0-nightly.20250514",
+    "@aztec/foundation": "0.86.0-nightly.20250514",
+    "@aztec/native": "0.86.0-nightly.20250514",
+    "@aztec/stdlib": "0.86.0-nightly.20250514",
     "idb": "^8.0.0",
     "lmdb": "^3.2.0",
     "msgpackr": "^1.11.2",

package/src/interfaces/common.ts

@@ -1,14 +1,10 @@
-/**
- * The key type for use with the kv-store
- */
-export type Key = string | number | Array<string | number>;
+/** The key type for use with the kv-store */
+export type Key = string | number | Uint8Array | Array<string | number>;
 
 export type Value = NonNullable<any>;
 
-/**
- * A range of keys to iterate over.
- */
-export type Range<K extends Key = Key> = {
+/** A range of keys of arbitrary type. */
+export type CustomRange<K> = {
   /** The key of the first item to include */
   start?: K;
   /** The key of the last item to include */
@@ -19,4 +15,17 @@ export type Range<K extends Key = Key> = {
   limit?: number;
 };
 
+/** Maps a custom range into a range of valid key types to iterate over. */
+export function mapRange<CK, K extends Key = Key>(range: CustomRange<CK>, mapFn: (key: CK) => K): Range<K> {
+  return {
+    start: range.start ? mapFn(range.start) : undefined,
+    end: range.end ? mapFn(range.end) : undefined,
+    reverse: range.reverse,
+    limit: range.limit,
+  };
+}
+
+/** A range of keys to iterate over. */
+export type Range<K extends Key = Key> = CustomRange<K>;
+
 export type StoreSize = { mappingSize: number; physicalFileSize: number; actualSize: number; numItems: number };

package/src/interfaces/index.ts

@@ -5,4 +5,5 @@ export * from './singleton.js';
 export * from './store.js';
 export * from './set.js';
 export * from './multi_map.js';
-export type { Range, StoreSize } from './common.js';
+export { mapRange } from './common.js';
+export type { CustomRange, Range, StoreSize } from './common.js';