@aztec/kv-store 0.0.0-test.0 → 0.0.1-commit.0208eb9

package/dest/interfaces/map_test_suite.js

@@ -7,7 +7,7 @@ export function describeAztecMap(testName, getStore, forceAsync = false) {
         let map;
         beforeEach(async ()=>{
             store = await getStore();
-            map = store.openMultiMap('test');
+            map = store.openMap('test');
         });
         afterEach(async ()=>{
             await store.delete();
@@ -15,6 +15,9 @@ export function describeAztecMap(testName, getStore, forceAsync = false) {
         async function get(key, sut = map) {
             return isSyncStore(store) && !forceAsync ? sut.get(key) : await sut.getAsync(key);
         }
+        async function size(sut = map) {
+            return isSyncStore(store) && !forceAsync ? sut.size() : await sut.sizeAsync();
+        }
         async function entries() {
             return isSyncStore(store) && !forceAsync ? await toArray(map.entries()) : await toArray(map.entriesAsync());
         }
@@ -24,9 +27,6 @@ export function describeAztecMap(testName, getStore, forceAsync = false) {
         async function keys(range, sut = map) {
             return isSyncStore(store) && !forceAsync ? await toArray(sut.keys(range)) : await toArray(sut.keysAsync(range));
         }
-        async function getValues(key) {
-            return isSyncStore(store) && !forceAsync ? await toArray(map.getValues(key)) : await toArray(map.getValuesAsync(key));
-        }
         it('should be able to set and get values', async ()=>{
             await map.set('foo', 'bar');
             await map.set('baz', 'qux');
@@ -34,6 +34,23 @@ export function describeAztecMap(testName, getStore, forceAsync = false) {
             expect(await get('baz')).to.equal('qux');
             expect(await get('quux')).to.equal(undefined);
         });
+        it('should be able to set many values', async ()=>{
+            const pairs = Array.from({
+                length: 100
+            }, (_, i)=>({
+                    key: `key${i}`,
+                    value: `value${i}`
+                }));
+            await map.setMany(pairs);
+            for (const { key, value } of pairs){
+                expect(await get(key)).to.equal(value);
+            }
+        });
+        it('should be able to overwrite values', async ()=>{
+            await map.set('foo', 'bar');
+            await map.set('foo', 'baz');
+            expect(await get('foo')).to.equal('baz');
+        });
         it('should be able to set values if they do not exist', async ()=>{
             expect(await map.setIfNotExists('foo', 'bar')).to.equal(true);
             expect(await map.setIfNotExists('foo', 'baz')).to.equal(false);
@@ -46,6 +63,35 @@ export function describeAztecMap(testName, getStore, forceAsync = false) {
             expect(await get('foo')).to.equal(undefined);
             expect(await get('baz')).to.equal('qux');
         });
+        it('should be able to return size of the map', async ()=>{
+            await map.set('foo', 'bar');
+            expect(await size()).to.equal(1);
+            await map.set('baz', 'qux');
+            expect(await size()).to.equal(2);
+            await map.delete('foo');
+            expect(await size()).to.equal(1);
+        });
+        it('returns 0 for empty map size', async ()=>{
+            expect(await size()).to.equal(0);
+        });
+        it('calculates size correctly across multiple operations', async ()=>{
+            expect(await size()).to.equal(0);
+            // Add items
+            await map.set('a', 'value1');
+            await map.set('b', 'value2');
+            await map.set('c', 'value3');
+            expect(await size()).to.equal(3);
+            // Update existing (size should not change)
+            await map.set('b', 'updated');
+            expect(await size()).to.equal(3);
+            // Delete some
+            await map.delete('a');
+            expect(await size()).to.equal(2);
+            // Delete all
+            await map.delete('b');
+            await map.delete('c');
+            expect(await size()).to.equal(0);
+        });
         it('should be able to iterate over entries when there are no keys', async ()=>{
             expect(await entries()).to.deep.equal([]);
         });
@@ -79,73 +125,138 @@ export function describeAztecMap(testName, getStore, forceAsync = false) {
                 'foo'
             ]);
         });
-        it('should be able to get multiple values for a single key', async ()=>{
-            await map.set('foo', 'bar');
-            await map.set('foo', 'baz');
-            expect(await getValues('foo')).to.deep.equal([
-                'bar',
-                'baz'
-            ]);
-        });
-        it('should be able to delete individual values for a single key', async ()=>{
-            await map.set('foo', 'bar');
-            await map.set('foo', 'baz');
-            await map.deleteValue('foo', 'bar');
-            expect(await getValues('foo')).to.deep.equal([
-                'baz'
-            ]);
-        });
-        it('supports range queries', async ()=>{
-            await map.set('a', 'a');
-            await map.set('b', 'b');
-            await map.set('c', 'c');
-            await map.set('d', 'd');
-            expect(await keys({
-                start: 'b',
-                end: 'c'
-            })).to.deep.equal([
-                'b'
-            ]);
-            expect(await keys({
-                start: 'b'
-            })).to.deep.equal([
-                'b',
-                'c',
-                'd'
-            ]);
-            expect(await keys({
-                end: 'c'
-            })).to.deep.equal([
-                'a',
-                'b'
-            ]);
-            expect(await keys({
-                start: 'b',
-                end: 'c',
-                reverse: true
-            })).to.deep.equal([
-                'c'
-            ]);
-            expect(await keys({
-                start: 'b',
-                limit: 1
-            })).to.deep.equal([
-                'b'
-            ]);
-            expect(await keys({
-                start: 'b',
-                reverse: true
-            })).to.deep.equal([
-                'd',
-                'c'
-            ]);
-            expect(await keys({
-                end: 'b',
-                reverse: true
-            })).to.deep.equal([
-                'b',
-                'a'
+        it('should be able to iterate over string keys that represent numbers', async ()=>{
+            await map.set('0x22', 'bar');
+            await map.set('0x31', 'qux');
+            expect(await keys()).to.deep.equal([
+                '0x22',
+                '0x31'
             ]);
         });
+        for (const [name, data] of [
+            [
+                'chars',
+                [
+                    'a',
+                    'b',
+                    'c',
+                    'd'
+                ]
+            ],
+            [
+                'numbers',
+                [
+                    1,
+                    2,
+                    3,
+                    4
+                ]
+            ],
+            [
+                'negative numbers',
+                [
+                    -4,
+                    -3,
+                    -2,
+                    -1
+                ]
+            ],
+            [
+                'strings',
+                [
+                    'aaa',
+                    'bbb',
+                    'ccc',
+                    'ddd'
+                ]
+            ],
+            [
+                'zero-based numbers',
+                [
+                    0,
+                    1,
+                    2,
+                    3
+                ]
+            ],
+            [
+                'large numbers',
+                [
+                    100,
+                    999,
+                    1000,
+                    1001
+                ]
+            ],
+            [
+                'mixed negative and positive',
+                [
+                    -1000,
+                    -1,
+                    1,
+                    1000
+                ]
+            ]
+        ]){
+            it(`supports range queries over ${name} keys`, async ()=>{
+                const [a, b, c, d] = data;
+                await map.set(a, 'a');
+                await map.set(b, 'b');
+                await map.set(c, 'c');
+                await map.set(d, 'd');
+                expect(await keys()).to.deep.equal([
+                    a,
+                    b,
+                    c,
+                    d
+                ]);
+                expect(await keys({
+                    start: b,
+                    end: c
+                })).to.deep.equal([
+                    b
+                ]);
+                expect(await keys({
+                    start: b
+                })).to.deep.equal([
+                    b,
+                    c,
+                    d
+                ]);
+                expect(await keys({
+                    end: c
+                })).to.deep.equal([
+                    a,
+                    b
+                ]);
+                expect(await keys({
+                    start: b,
+                    end: c,
+                    reverse: true
+                })).to.deep.equal([
+                    c
+                ]);
+                expect(await keys({
+                    start: b,
+                    limit: 1
+                })).to.deep.equal([
+                    b
+                ]);
+                expect(await keys({
+                    start: b,
+                    reverse: true
+                })).to.deep.equal([
+                    d,
+                    c
+                ]);
+                expect(await keys({
+                    end: b,
+                    reverse: true
+                })).to.deep.equal([
+                    b,
+                    a
+                ]);
+            });
+        }
     });
 }

package/dest/interfaces/multi_map.d.ts

@@ -0,0 +1,41 @@
+import type { Key, Value } from './common.js';
+import type { AztecAsyncMap, AztecMap } from './map.js';
+/**
+ * A map backed by a persistent store that can have multiple values for a single key.
+ */
+export interface AztecMultiMap<K extends Key, V extends Value> extends AztecMap<K, V> {
+    /**
+     * Gets all the values at the given key.
+     * @param key - The key to get the values from
+     */
+    getValues(key: K): IterableIterator<V>;
+    /**
+     * Deletes a specific value at the given key.
+     * @param key - The key to delete the value at
+     * @param val - The value to delete
+     */
+    deleteValue(key: K, val: V): Promise<void>;
+}
+/**
+ * A map backed by a persistent store that can have multiple values for a single key.
+ */
+export interface AztecAsyncMultiMap<K extends Key, V extends Value> extends AztecAsyncMap<K, V> {
+    /**
+     * Gets all the values at the given key.
+     * @param key - The key to get the values from
+     */
+    getValuesAsync(key: K): AsyncIterableIterator<V>;
+    /**
+     * Gets the number of values at the given key.
+     * @param key - The key to get the number of values from
+     * @returns The number of values at the given key
+     */
+    getValueCountAsync(key: K): Promise<number>;
+    /**
+     * Deletes a specific value at the given key.
+     * @param key - The key to delete the value at
+     * @param val - The value to delete
+     */
+    deleteValue(key: K, val: V): Promise<void>;
+}
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibXVsdGlfbWFwLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvaW50ZXJmYWNlcy9tdWx0aV9tYXAudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxLQUFLLEVBQUUsR0FBRyxFQUFFLEtBQUssRUFBRSxNQUFNLGFBQWEsQ0FBQztBQUM5QyxPQUFPLEtBQUssRUFBRSxhQUFhLEVBQUUsUUFBUSxFQUFFLE1BQU0sVUFBVSxDQUFDO0FBRXhEOztHQUVHO0FBQ0gsTUFBTSxXQUFXLGFBQWEsQ0FBQyxDQUFDLFNBQVMsR0FBRyxFQUFFLENBQUMsU0FBUyxLQUFLLENBQUUsU0FBUSxRQUFRLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUNuRjs7O09BR0c7SUFDSCxTQUFTLENBQUMsR0FBRyxFQUFFLENBQUMsR0FBRyxnQkFBZ0IsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUV2Qzs7OztPQUlHO0lBQ0gsV0FBVyxDQUFDLEdBQUcsRUFBRSxDQUFDLEVBQUUsR0FBRyxFQUFFLENBQUMsR0FBRyxPQUFPLENBQUMsSUFBSSxDQUFDLENBQUM7Q0FDNUM7QUFFRDs7R0FFRztBQUNILE1BQU0sV0FBVyxrQkFBa0IsQ0FBQyxDQUFDLFNBQVMsR0FBRyxFQUFFLENBQUMsU0FBUyxLQUFLLENBQUUsU0FBUSxhQUFhLENBQUMsQ0FBQyxFQUFFLENBQUMsQ0FBQztJQUM3Rjs7O09BR0c7SUFDSCxjQUFjLENBQUMsR0FBRyxFQUFFLENBQUMsR0FBRyxxQkFBcUIsQ0FBQyxDQUFDLENBQUMsQ0FBQztJQUVqRDs7OztPQUlHO0lBQ0gsa0JBQWtCLENBQUMsR0FBRyxFQUFFLENBQUMsR0FBRyxPQUFPLENBQUMsTUFBTSxDQUFDLENBQUM7SUFFNUM7Ozs7T0FJRztJQUNILFdBQVcsQ0FBQyxHQUFHLEVBQUUsQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFDLEdBQUcsT0FBTyxDQUFDLElBQUksQ0FBQyxDQUFDO0NBQzVDIn0=

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

@@ -0,0 +1 @@
+{"version":3,"file":"multi_map.d.ts","sourceRoot":"","sources":["../../src/interfaces/multi_map.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAC;AAExD;;GAEG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,CAAE,SAAQ,QAAQ,CAAC,CAAC,EAAE,CAAC,CAAC;IACnF;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,CAAC,GAAG,gBAAgB,CAAC,CAAC,CAAC,CAAC;IAEvC;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB,CAAC,CAAC,SAAS,GAAG,EAAE,CAAC,SAAS,KAAK,CAAE,SAAQ,aAAa,CAAC,CAAC,EAAE,CAAC,CAAC;IAC7F;;;OAGG;IACH,cAAc,CAAC,GAAG,EAAE,CAAC,GAAG,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAEjD;;;;OAIG;IACH,kBAAkB,CAAC,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE5C;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC5C"}

package/dest/interfaces/multi_map.js

@@ -0,0 +1,3 @@
+/**
+ * A map backed by a persistent store that can have multiple values for a single key.
+ */ export { };

package/dest/interfaces/multi_map_test_suite.d.ts

@@ -0,0 +1,3 @@
+import type { AztecAsyncKVStore, AztecKVStore } from './store.js';
+export declare function describeAztecMultiMap(testName: string, getStore: () => AztecKVStore | Promise<AztecAsyncKVStore>, forceAsync?: boolean): void;
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibXVsdGlfbWFwX3Rlc3Rfc3VpdGUuZC50cyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9pbnRlcmZhY2VzL211bHRpX21hcF90ZXN0X3N1aXRlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU1BLE9BQU8sS0FBSyxFQUFFLGlCQUFpQixFQUFFLFlBQVksRUFBRSxNQUFNLFlBQVksQ0FBQztBQUdsRSx3QkFBZ0IscUJBQXFCLENBQ25DLFFBQVEsRUFBRSxNQUFNLEVBQ2hCLFFBQVEsRUFBRSxNQUFNLFlBQVksR0FBRyxPQUFPLENBQUMsaUJBQWlCLENBQUMsRUFDekQsVUFBVSxHQUFFLE9BQWUsUUF5VzVCIn0=

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

@@ -0,0 +1 @@
+{"version":3,"file":"multi_map_test_suite.d.ts","sourceRoot":"","sources":["../../src/interfaces/multi_map_test_suite.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,iBAAiB,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAGlE,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,MAAM,EAChB,QAAQ,EAAE,MAAM,YAAY,GAAG,OAAO,CAAC,iBAAiB,CAAC,EACzD,UAAU,GAAE,OAAe,QAyW5B"}