Returned WithIdAndVersion from find methods

event-driven-io · Oct 2, 2024 · f3e2157 · f3e2157
1 parent 8049d19
commit f3e2157
Show file tree

Hide file tree

Showing 8 changed files with 26 additions and 22 deletions.
diff --git a/samples/simple-ts/src/shim.ts b/samples/simple-ts/src/shim.ts
@@ -33,6 +33,6 @@ console.log(anitaFromDb);
 
 // Finding more
 const usersFromDB = await users.find({ age: { $lt: 40 } }).toArray();
-console.log(JSON.stringify(usersFromDB));
+console.log(usersFromDB);
 
 await pongoClient.close();
diff --git a/samples/simple-ts/src/typedClient.ts b/samples/simple-ts/src/typedClient.ts
@@ -31,10 +31,10 @@ await users.deleteOne({ _id: cruella._id });
 
 // Finding by Id
 const anitaFromDb = await users.findOne({ _id: anitaId });
-console.log(JSON.stringify(anitaFromDb));
+console.log(anitaFromDb);
 
 // Finding more
 const usersFromDB = await users.find({ age: { $lt: 40 } });
-console.log(JSON.stringify(usersFromDB));
+console.log(usersFromDB);
 
 await pongo.close();
diff --git a/src/package-lock.json b/src/package-lock.json
diff --git a/src/package.json b/src/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@event-driven-io/pongo-core",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "Pongo - Mongo with strong consistency on top of Postgres",
   "type": "module",
   "engines": {

diff --git a/src/packages/pongo/package.json b/src/packages/pongo/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@event-driven-io/pongo",
-  "version": "0.15.0",
+  "version": "0.15.1",
   "description": "Pongo - Mongo with strong consistency on top of Postgres",
   "type": "module",
   "scripts": {

diff --git a/src/packages/pongo/src/core/collection/pongoCollection.ts b/src/packages/pongo/src/core/collection/pongoCollection.ts
@@ -38,6 +38,7 @@ import {
   type ReplaceOneOptions,
   type UpdateManyOptions,
   type UpdateOneOptions,
+  type WithIdAndVersion,
   type WithoutId,
   type WithVersion,
 } from '..';
@@ -282,16 +283,16 @@ export const pongoCollection = <
     findOne: async (
       filter?: PongoFilter<T>,
       options?: CollectionOperationOptions,
-    ): Promise<T | null> => {
+    ): Promise<WithIdAndVersion<T> | null> => {
       await ensureCollectionCreated(options);
 
       const result = await query(SqlFor.findOne(filter ?? {}), options);
-      return (result.rows[0]?.data ?? null) as T | null;
+      return (result.rows[0]?.data ?? null) as WithIdAndVersion<T> | null;
     },
     findOneAndDelete: async (
       filter: PongoFilter<T>,
       options?: DeleteOneOptions,
-    ): Promise<T | null> => {
+    ): Promise<WithIdAndVersion<T> | null> => {
       await ensureCollectionCreated(options);
 
       const existingDoc = await collection.findOne(filter, options);
@@ -305,7 +306,7 @@ export const pongoCollection = <
       filter: PongoFilter<T>,
       replacement: WithoutId<T>,
       options?: ReplaceOneOptions,
-    ): Promise<T | null> => {
+    ): Promise<WithIdAndVersion<T> | null> => {
       await ensureCollectionCreated(options);
 
       const existingDoc = await collection.findOne(filter, options);
@@ -320,7 +321,7 @@ export const pongoCollection = <
       filter: PongoFilter<T>,
       update: PongoUpdate<T>,
       options?: UpdateOneOptions,
-    ): Promise<T | null> => {
+    ): Promise<WithIdAndVersion<T> | null> => {
       await ensureCollectionCreated(options);
 
       const existingDoc = await collection.findOne(filter, options);
@@ -427,11 +428,11 @@ export const pongoCollection = <
     find: async (
       filter?: PongoFilter<T>,
       options?: CollectionOperationOptions,
-    ): Promise<T[]> => {
+    ): Promise<WithIdAndVersion<T>[]> => {
       await ensureCollectionCreated(options);
 
       const result = await query(SqlFor.find(filter ?? {}));
-      return result.rows.map((row) => row.data as T);
+      return result.rows.map((row) => row.data as WithIdAndVersion<T>);
     },
     countDocuments: async (
       filter?: PongoFilter<T>,

diff --git a/src/packages/pongo/src/core/typing/operations.ts b/src/packages/pongo/src/core/typing/operations.ts
@@ -159,25 +159,25 @@ export interface PongoCollection<T extends PongoDocument> {
   findOne(
     filter?: PongoFilter<T> | SQL,
     options?: CollectionOperationOptions,
-  ): Promise<T | null>;
+  ): Promise<WithIdAndVersion<T> | null>;
   find(
     filter?: PongoFilter<T> | SQL,
     options?: CollectionOperationOptions,
-  ): Promise<T[]>;
+  ): Promise<WithIdAndVersion<T>[]>;
   findOneAndDelete(
     filter: PongoFilter<T> | SQL,
     options?: DeleteOneOptions,
-  ): Promise<T | null>;
+  ): Promise<WithIdAndVersion<T> | null>;
   findOneAndReplace(
     filter: PongoFilter<T> | SQL,
     replacement: WithoutId<T>,
     options?: ReplaceOneOptions,
-  ): Promise<T | null>;
+  ): Promise<WithIdAndVersion<T> | null>;
   findOneAndUpdate(
     filter: PongoFilter<T> | SQL,
     update: PongoUpdate<T> | SQL,
     options?: UpdateOneOptions,
-  ): Promise<T | null>;
+  ): Promise<WithIdAndVersion<T> | null>;
   countDocuments(
     filter?: PongoFilter<T> | SQL,
     options?: CollectionOperationOptions,
@@ -261,6 +261,9 @@ export declare type WithVersion<TSchema> = EnhancedOmit<TSchema, '_version'> & {
 };
 export type WithoutVersion<T> = Omit<T, '_version'>;
 
+export type WithIdAndVersion<T> = WithId<WithVersion<T>>;
+export type WithoutIdAndVersion<T> = WithoutId<WithoutVersion<T>>;
+
 /** @public */
 export declare type RegExpOrString<T> = T extends string ? RegExp | T : T;
 

diff --git a/src/packages/pongo/src/mongo/mongoCollection.ts b/src/packages/pongo/src/mongo/mongoCollection.ts
@@ -252,10 +252,10 @@ export class Collection<T extends Document> implements MongoCollection<T> {
     filter?: unknown,
     options?: FindOptions<Document> | undefined,
   ): Promise<import('mongodb').WithId<T> | T | null> {
-    return this.collection.findOne(
+    return (await this.collection.findOne(
       filter as PongoFilter<T>,
       toCollectionOperationOptions(options),
-    );
+    )) as T;
   }
   find(): MongoFindCursor<WithId<T>>;
   find(