Added peer dependency to pg and uuid types

Adjusted also README to show proper samples

README.md

@@ -29,32 +29,32 @@ type User = { name: string; age: number };
 const connectionString =
   "postgresql://dbuser:[email protected]:3211/mydb";
 
-const pongoClient = pongoClient(connectionString);
-const pongoDb = pongoClient.db();
+const pongo = pongoClient(connectionString);
+const pongoDb = pongo.db();
 
 const users = pongoDb.collection<User>("users");
 const roger = { name: "Roger", age: 30 };
 const anita = { name: "Anita", age: 25 };
 const cruella = { _id: uuid(), name: "Cruella", age: 40 };
 
 // Inserting
-await pongoCollection.insertOne(roger);
-await pongoCollection.insertOne(cruella);
+await users.insertOne(roger);
+await users.insertOne(cruella);
 
-const { insertedId } = await pongoCollection.insertOne(anita);
+const { insertedId } = await users.insertOne(anita);
 const anitaId = insertedId;
 
 // Updating
 await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });
 
 // Deleting
-await pongoCollection.deleteOne({ _id: cruella._id });
+await users.deleteOne({ _id: cruella._id });
 
 // Finding by Id
-const anitaFromDb = await pongoCollection.findOne({ _id: anitaId });
+const anitaFromDb = await users.findOne({ _id: anitaId });
 
 // Finding more
-const users = await pongoCollection.find({ age: { $lt: 40 } });
+users = await users.find({ age: { $lt: 40 } });
 ```
 
 Or use MongoDB compliant shim:
@@ -77,23 +77,23 @@ const anita = { name: "Anita", age: 25 };
 const cruella = { _id: uuid(), name: "Cruella", age: 40 };
 
 // Inserting
-await pongoCollection.insertOne(roger);
-await pongoCollection.insertOne(cruella);
+await users.insertOne(roger);
+await users.insertOne(cruella);
 
-const { insertedId } = await pongoCollection.insertOne(anita);
+const { insertedId } = await users.insertOne(anita);
 const anitaId = insertedId;
 
 // Updating
 await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });
 
 // Deleting
-await pongoCollection.deleteOne({ _id: cruella._id });
+await users.deleteOne({ _id: cruella._id });
 
 // Finding by Id
-const anitaFromDb = await pongoCollection.findOne({ _id: anitaId });
+const anitaFromDb = await users.findOne({ _id: anitaId });
 
 // Finding more
-const users = await pongoCollection.find({ age: { $lt: 40 } }).toArray();
+users = await users.find({ age: { $lt: 40 } }).toArray();
 ```
 
 ## How does it work?
@@ -114,12 +114,9 @@ CREATE TABLE IF NOT EXISTS "YourCollectionName" (
 **E.g. the MongoDB update syntax:**
 
 ```ts
-const pongoCollection = pongoDb.collection<User>("users");
+const users = pongoDb.collection<User>("users");
 
-await pongoCollection.updateOne(
-  { _id: someId },
-  { $push: { tags: "character" } }
-);
+await users.updateOne({ _id: someId }, { $push: { tags: "character" } });
 ```
 
 will be translated to:
@@ -133,7 +130,7 @@ WHERE _id = '137ef052-e41c-428b-b606-1c8070a47eda';
 **Or for query:**
 
 ```ts
-const result = await pongoCollection
+const result = await users
   .find({ "address.history": { $elemMatch: { street: "Elm St" } } })
   .toArray();
 ```

src/docs/getting-started.md

@@ -27,32 +27,32 @@ type User = { name: string; age: number };
 const connectionString =
   'postgresql://dbuser:[email protected]:3211/mydb';
 
-const pongoClient = pongoClient(connectionString);
-const pongoDb = pongoClient.db();
+const pongo = pongoClient(connectionString);
+const pongoDb = pongo.db();
 
 const users = pongoDb.collection<User>('users');
 const roger = { name: 'Roger', age: 30 };
 const anita = { name: 'Anita', age: 25 };
 const cruella = { _id: uuid(), name: 'Cruella', age: 40 };
 
 // Inserting
-await pongoCollection.insertOne(roger);
-await pongoCollection.insertOne(cruella);
+await users.insertOne(roger);
+await users.insertOne(cruella);
 
-const { insertedId } = await pongoCollection.insertOne(anita);
+const { insertedId } = await users.insertOne(anita);
 const anitaId = insertedId;
 
 // Updating
 await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });
 
 // Deleting
-await pongoCollection.deleteOne({ _id: cruella._id });
+await users.deleteOne({ _id: cruella._id });
 
 // Finding by Id
-const anitaFromDb = await pongoCollection.findOne({ _id: anitaId });
+const anitaFromDb = await users.findOne({ _id: anitaId });
 
 // Finding more
-const users = await pongoCollection.find({ age: { $lt: 40 } });
+const users = await users.find({ age: { $lt: 40 } });
 ```
 
 Or use MongoDB compliant shim:
@@ -75,23 +75,23 @@ const anita = { name: 'Anita', age: 25 };
 const cruella = { _id: uuid(), name: 'Cruella', age: 40 };
 
 // Inserting
-await pongoCollection.insertOne(roger);
-await pongoCollection.insertOne(cruella);
+await users.insertOne(roger);
+await users.insertOne(cruella);
 
-const { insertedId } = await pongoCollection.insertOne(anita);
+const { insertedId } = await users.insertOne(anita);
 const anitaId = insertedId;
 
 // Updating
 await users.updateOne({ _id: anitaId }, { $set: { age: 31 } });
 
 // Deleting
-await pongoCollection.deleteOne({ _id: cruella._id });
+await users.deleteOne({ _id: cruella._id });
 
 // Finding by Id
-const anitaFromDb = await pongoCollection.findOne({ _id: anitaId });
+const anitaFromDb = await users.findOne({ _id: anitaId });
 
 // Finding more
-const users = await pongoCollection.find({ age: { $lt: 40 } }).toArray();
+const users = await users.find({ age: { $lt: 40 } }).toArray();
 ```
 
 ## How does it work?
@@ -112,12 +112,9 @@ CREATE TABLE IF NOT EXISTS "YourCollectionName" (
 **E.g. the MongoDB update syntax:**
 
 ```typescript
-const pongoCollection = pongoDb.collection<User>('users');
+const users = pongoDb.collection<User>('users');
 
-await pongoCollection.updateOne(
-  { _id: someId },
-  { $push: { tags: 'character' } },
-);
+await users.updateOne({ _id: someId }, { $push: { tags: 'character' } });
 ```
 
 will be translated to:
@@ -131,7 +128,7 @@ WHERE _id = '137ef052-e41c-428b-b606-1c8070a47eda';
 **Or for query:**
 
 ```typescript
-const result = await pongoCollection
+const result = await users
   .find({ 'address.history': { $elemMatch: { street: 'Elm St' } } })
   .toArray();
 ```

src/packages/pongo/package.json

@@ -47,14 +47,15 @@
     "dist"
   ],
   "peerDependencies": {
+    "@types/uuid": "^9.0.8",
+    "@types/pg": "^8.11.6",
+    "@types/pg-format": "^1.0.5",
+    "@types/mongodb": "^4.0.7",
     "pg": "^8.12.0",
     "pg-format": "^1.0.4",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@types/uuid": "^9.0.8",
-    "@types/node": "20.11.30",
-    "@types/pg": "^8.11.6",
-    "@types/pg-format": "^1.0.5"
+    "@types/node": "20.11.30"
   }
 }

src/packages/pongo/src/main/typing/operations.ts

@@ -30,8 +30,10 @@ export interface PongoCollection<T> {
 
 export type WithId<T> = T & { _id: string };
 
+export type WithoutId<T> = Omit<T, '_id'>;
+
 export type PongoFilter<T> = {
-  [P in keyof T]?: T[P] | PongoFilterOperator<T[P]>;
+  [P in keyof T]?: WithId<T[P]> | PongoFilterOperator<T[P]>;
 };
 
 export type PongoFilterOperator<T> = {

src/packages/pongo/src/mongo/mongoClient.ts

@@ -18,7 +18,7 @@ export class MongoClient {
     await this.pongoClient.close();
   }
 
-  db(dbName: string): Db {
+  db(dbName?: string): Db {
     return new Db(this.pongoClient.db(dbName));
   }
 }