use json() method and update readme

Author: Andndre

README.md

@@ -1,39 +1,34 @@
-# Deno MongoDB Atlas Data API Wrapper
+# Deno MongoDB Atlas Data API
 
-This is a simple library that turns the long and repeating code to access the MongoDB Data API into more simple, readable, and maintainable code.
+This is a simple library that provides an interface to the MongoDB Atlas Data API. The library can be used to perform basic CRUD (Create, Read, Update, and Delete) operations on a MongoDB database without the need for a dedicated driver.
+
+The library is written in TypeScript, and it provides TypeScript definitions for all of its methods.
+
+## Usage
+To use the DataAPI library, you first need to initialize it with your MongoDB Atlas API key and the URL of your Data API endpoint. You can then use the insertOne, insertMany, findOne, find, updateOne, and deleteOne methods to perform CRUD operations on your database.
+
+Here's an example of how you can use the library to insert a document into a collection:
 
-This library can simplify your code from this:
 ```ts
-const URL = BASE_URL + '/insertOne';
-const response = await fetch(URL, {
-	method: 'POST',
-	headers: {
-		'Content-Type': 'application/json',
-		'api-key': API_KEY,
-	},
-	body: JSON.stringify({
-		collection: 'collectionName',
-		database: 'databaseName',
-		dataSource: 'the-data-source',
-		document: {
-			name: 'test',
-			age: 17
-		},
-	}),
+import { DataAPI } from "https://deno.land/x/mongodbdataapi/mod.ts";
+
+const api = DataAPI.init(
+  "https://data.mongodb-api.com/app/data-abcde/endpoint/data/v1/action", // remember to add "/action"!
+  "my-cluster",
+  "my-database",
+  "my-api-key",
+);
+
+const result = await api.insertOne("my-collection", {
+  name: "John Doe",
+  age: 42,
 });
-```
-to this:
-```ts
-const instance = DataAPI.get();
-instance.insertOne('collectionName', {name: 'test', age: 17})
-```
-But make sure to initialize the DataAPI instance with this code first:
-```ts
-import { DataAPI } from 'https://deno.land/x/mongodbdataapi/mod.ts';
 
-const instance = DataAPI.init(BASE_URL + '/action', DATA_SOURCE, DATABASE, API_KEY) // returns the DataAPI instance
+console.log(result);
 ```
 
+The `init` method initializes the library with the URL of the Data API endpoint, the name of the cluster, the name of the database, and the API key. The insertOne method is then used to insert a document into the my-collection collection. The result of the operation is logged to the console.
+
 ## When to Use the Data API
 
 *taken straight from this [documentation page](https://www.mongodb.com/docs/atlas/api/data-api/)*

dataApi.ts

@@ -29,8 +29,11 @@ export class DataAPI {
   }
   /**
    * @param url for example: " https://data.mongodb-api.com/app/data-abcde/endpoint/data/v1/action "
+   * @param dataSource your cluster
+   * @param databaseName database name inside your cluster
    * @param apiKey
-   * @returns
+   *
+   * @see https://www.mongodb.com/docs/atlas/api/data-api/
    */
   static init(
     url: string,
@@ -52,6 +55,12 @@ export class DataAPI {
     }
     return DataAPI.instance!;
   }
+  /**
+   * @param collection
+   * @param document
+   *
+   * @see https://www.mongodb.com/docs/atlas/api/data-api/
+   */
   // deno-lint-ignore no-explicit-any
   async insertOne(collection: string, document: any) {
     const URI = this.url + "/insertOne";
@@ -67,12 +76,16 @@ export class DataAPI {
         document,
       }),
     });
-    const json = (await readJSON(response.body!)) as Inserted;
-    return json;
+    return await response.json() as Inserted;
   }
 
-  // deno-lint-ignore no-explicit-any
-  async insertMany(collection: string, documents: any[]) {
+  /**
+   * @param collection
+   * @param documents
+   *
+   * @see https://www.mongodb.com/docs/atlas/api/data-api/
+   */
+  async insertMany<T>(collection: string, documents: T[]) {
     const URI = this.url + "/insertMany";
     const response = await fetch(URI, {
       method: "POST",
@@ -86,11 +99,16 @@ export class DataAPI {
         documents,
       }),
     });
-    const json = (await readJSON(response.body!)) as InsertedMany;
-    return json;
+    return await response.json() as InsertedMany;
   }
+  /**
+   * @param collection
+   * @param filter
+   *
+   * @see https://www.mongodb.com/docs/atlas/api/data-api/
+   */
   // deno-lint-ignore no-explicit-any
-  async findOne(collection: string, filter: any) {
+  async findOne<T>(collection: string, filter: any) {
     const URI = this.url + "/findOne";
     const response = await fetch(URI, {
       method: "POST",
@@ -104,17 +122,17 @@ export class DataAPI {
         filter,
       }),
     });
-    const json = (await readJSON(response.body!)) as FindOne;
-    return json;
+    return await response.json() as FindOne<T>;
   }
   /**
    * @param collection
    * @param filter example: { "breed": "Labrador", "age": { "$gt" : 2} }
    * @param sort example: { "age" : 1 }
-   * @returns
+   *
+   * @see https://www.mongodb.com/docs/atlas/api/data-api/
    */
   // deno-lint-ignore no-explicit-any
-  async find(collection: string, filter: any, sort?: any) {
+  async find<T>(collection: string, filter: any, sort?: any) {
     const URI = this.url + "/find";
     const response = await fetch(URI, {
       method: "POST",
@@ -129,8 +147,7 @@ export class DataAPI {
         sort,
       }),
     });
-    const json = (await readJSON(response.body!)) as Find;
-    return json;
+    return await response.json() as Find<T>;
   }
   /**
    * @param collection
@@ -154,8 +171,7 @@ export class DataAPI {
         update,
       }),
     });
-    const json = (await readJSON(response.body!)) as UpdateOne;
-    return json;
+    return await response.json() as UpdateOne;
   }
   // deno-lint-ignore no-explicit-any
   async deleteOne(collection: string, filter: any) {
@@ -172,8 +188,7 @@ export class DataAPI {
         filter,
       }),
     });
-    const json = (await readJSON(response.body!)) as DeleteOne;
-    return json;
+    return await response.json() as DeleteOne;
   }
   // deno-lint-ignore no-explicit-any
   async aggregate(collection: string, pipeline: any) {
@@ -190,8 +205,8 @@ export class DataAPI {
         pipeline,
       }),
     });
-    const json = await readJSON(response.body!);
-    return json;
+
+    return await response.json();
   }
   /**
 	 * ```ts
@@ -209,7 +224,8 @@ export class DataAPI {
 		}),
 	});
 	 * ```
-	 * for more information, please [read](https://www.mongodb.com/developer/products/atlas/atlas-data-api-introduction/)
+   *
+	 * @see https://www.mongodb.com/docs/atlas/api/data-api/
 	 */
   // deno-lint-ignore no-explicit-any
   async custom(collection: string, action: string, query: any) {
@@ -226,18 +242,6 @@ export class DataAPI {
         ...query,
       }),
     });
-    const json = await readJSON(response.body!);
-    return json;
+    return await response.json();
   }
 }
-
-async function readText(rs: ReadableStream<Uint8Array>) {
-  const reader = rs.getReader();
-  const value = (await reader.read()).value;
-  reader.cancel();
-  return new TextDecoder().decode(value);
-}
-
-async function readJSON(rs: ReadableStream<Uint8Array>) {
-  return JSON.parse(await readText(rs));
-}

types.ts

@@ -6,14 +6,12 @@ export type InsertedMany = {
   insertedIds: string[];
 };
 
-export type FindOne = {
-  // deno-lint-ignore no-explicit-any
-  document: any;
+export type FindOne<T> = {
+  document: T;
 };
 
-export type Find = {
-  // deno-lint-ignore no-explicit-any
-  documents: any[];
+export type Find<T> = {
+  documents: T[];
 };
 
 export type UpdateOne = {