Update API

Author: julienmalard

README.md

@@ -16,10 +16,10 @@ As `Nested` database is like a [`KeyValue`](https://github.com/orbitdb/orbitdb/b
 A simple example with `Nested`:
 ```ts
 import { createOrbitDB } from "@orbitdb/core";
-import { registerNested, toNested } from "@orbitdb/nested-db";
+import { Nested } from "@orbitdb/nested-db";
 
 // Register nested database type. IMPORTANT - must call before creating orbit instance !
-registerNested();
+useDatabaseType(Nested);
 
 const orbitdb = await createOrbitDB({ ipfs })
 
@@ -29,8 +29,7 @@ await db.put("a", 1);
 await db.put("b/c", 2);
 await db.put(["b", "d"], 3)  // Alternative syntax
 
-const all = await db.all();  // [{ key: "a", value: 1}, { key: "b/c", value: 2 }, { key: "b/d", value: 3 }]
-toNested(all)  // { a: 1, b: { c: 2, d: 3 } }
+const all = await db.all();  // { a: 1, b: { c: 2, d: 3 } }
 
 await db.get("b")  // { c: 2, d: 3 }
 
@@ -41,10 +40,10 @@ await db.all();  // { "a": 1 }
 A more complex example with object types:
 ```ts
 import { createOrbitDB } from "@orbitdb/core";
-import { registerNested, toNested } from "@orbitdb/nested-db";
+import { Nested } from "@orbitdb/nested-db";
 
 // Register nested database type. IMPORTANT - must call before creating orbit instance !
-registerNested();
+useDatabaseType(Nested);
 
 const orbit = await createOrbitDB({ ipfs })
 
@@ -53,8 +52,7 @@ const db = await orbitdb.open({ type: "nested" });
 await db.putNested({ a: { b: 1, c: 2 } });
 await db.putNested({ d: 3 });
 
-const all = await db.all();  // [{ key: "a/b", value: 1 }, { key: "a/c", value: 2 }, { key:  "d", value: 3 }]
-toNested(all)  // { a: { b: 1, c: 2}, d: 3 }
+const all = await db.all();  // { a: { b: 1, c: 2}, d: 3 }
 
 ```
 

src/index.ts

@@ -1,7 +1,6 @@
 export { default as Nested, NestedDatabaseType } from "@/nested.js";
 
 export {
-  registerNested,
   flatten,
   toNested,
   splitKey,

src/nested.ts

@@ -150,18 +150,12 @@ const Nested =
       }
     };
 
-    const all = async (): Promise<
-      {
-        key: string;
-        value: DagCborEncodable;
-        hash: string;
-      }[]
-    > => {
+    const all = async (): Promise<NestedValue> => {
       const values = [];
       for await (const entry of iterator()) {
         values.unshift(entry);
       }
-      return values;
+      return toNested(values);
     };
 
     return {

src/utils.ts

@@ -3,8 +3,6 @@ import { DagCborEncodable, useDatabaseType } from "@orbitdb/core";
 import Nested from "@/nested.js";
 import { NestedValue, PossiblyNestedValue } from "./types";
 
-export const registerNested = () => useDatabaseType(Nested);
-
 export const splitKey = (key: string): string[] => key.split("/");
 export const joinKey = (key: string[]): string => key.join("/");
 

test/nested.spec.ts

@@ -162,14 +162,11 @@ describe("Nested Database", () => {
     });
 
     it("add a nested value", async () => {
-      const hash1 = await db.put("a/b", 1);
-      const hash2 = await db.put("a/c", 2);
+      await db.put("a/b", 1);
+      await db.put("a/c", 2);
 
       const actual = await db.all();
-      expect(actual).to.have.deep.members([
-        { key: "a/b", value: 1, hash: hash1 },
-        { key: "a/c", value: 2, hash: hash2 },
-      ]);
+      expect(actual).to.deep.equal({ a: { b: 1, c: 2 }});
     });
 
     it("get a nested value", async () => {
@@ -195,14 +192,11 @@ describe("Nested Database", () => {
     });
 
     it("add a nested value - list syntax", async () => {
-      const hash1 = await db.put(["a", "b"], 1);
-      const hash2 = await db.put(["a", "c"], 2);
+      await db.put(["a", "b"], 1);
+      await db.put(["a", "c"], 2);
 
       const actual = await db.all();
-      expect(actual).to.have.deep.members([
-        { key: "a/b", value: 1, hash: hash1 },
-        { key: "a/c", value: 2, hash: hash2 },
-      ]);
+      expect(actual).to.deep.equal({ a: { b: 1, c: 2 }});
     });
 
     it("remove root key", async () => {
@@ -219,35 +213,32 @@ describe("Nested Database", () => {
       await db.put("a/b", 1);
       await db.put("a/c", 2);
 
-      const hash = await db.put("a", 3);
+      await db.put("a", 3);
 
       const actual = await db.all();
-      expect(actual).to.have.deep.members([{ key: "a", value: 3, hash }]);
+      expect(actual).to.deep.equal({ a: 3 });
     });
 
     it("put nested", async () => {
-      const hashes = await db.putNested({ a: { b: 1, c: 2 } });
+      await db.putNested({ a: { b: 1, c: 2 } });
 
       const actual = await db.all();
-      expect(actual).to.have.deep.members([
-        { key: "a/b", value: 1, hash: hashes[0] },
-        { key: "a/c", value: 2, hash: hashes[1] },
-      ]);
+      expect(actual).to.deep.equal({ a: { b: 1, c: 2 }});
     });
 
     it("put key nested value", async () => {
       await db.put("a", { b: 2, c: 3 });
       await db.put("a", { b: 1 });
 
-      const actual = toNested(await db.all());
+      const actual = await db.all();
       expect(actual).to.deep.equal({ a: { b: 1 } });
     });
 
     it("put nested value merges with previous values", async () => {
       await db.put("a", { b: 2, c: 3 });
       await db.putNested("a", { b: 1 });
 
-      const actual = toNested(await db.all());
+      const actual = await db.all();
       expect(actual).to.deep.equal({ a: { b: 1, c: 3 } });
     });