wingbot-mongodb 4.2.5 → 4.2.6

package/.github/workflows/test.yml

@@ -19,7 +19,7 @@ jobs:
 
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [20.x]
 
     steps:
 
@@ -27,7 +27,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Node.js ${{ matrix.node-version }} setup
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'

package/baseStorage.d.ts

@@ -6,26 +6,45 @@ declare namespace wingbotmongodb {
     type Db = import('mongodb').Db;
     type CreateIndexesOptions = import('mongodb').CreateIndexesOptions;
     type ObjectId = import('mongodb').ObjectId;
+    export interface Logger {
+        log: {(...any): void}
+        error: {(...any): void}
+    }
+
+    export type WithId<T extends object> = T & { _id: ObjectId };
 
     export class BaseStorage<T = {}> {
 
-        constructor (mongoDb: Db|{():Promise<Db>}, collectionName: string, log?: {error:Function, log:Function}, isCosmo?: boolean)
+        constructor (
+            mongoDb: Db|{():Promise<Db>},
+            collectionName: string,
+            log?: Logger,
+            isCosmo?: boolean
+        )
 
-        _getCollection (forRead?: boolean): Promise<Collection<T>>
+        _getCollection (forRead?: boolean): Promise<Collection<WithId<T>>>
 
-        public addFixtureDoc (...any: any)
+        public addFixtureDoc (...any: T)
 
         public addIndex (index: object, options: CreateIndexesOptions)
 
         protected _id (id: string): ObjectId
 
-        protected _expandObjectToSet (attr: string|null, obj: {[key: string]: any}, nested?: boolean): {[key: string]: any}
+        protected _expandObjectToSet (
+            attr: string|null,
+            obj: {[key: string]: any},
+            nested?: boolean
+        ): {[key: string]: any}
 
         protected _log: { log: Function, error: Function };
 
         public preHeat(): Promise<void>
 
         public drop (): Promise<void>
+
+        protected _catchNetworkIssues<I> (fn: {():I}): Promise<I>
+
+        protected _detectNetworkIssueException<E extends Error> (e: E): E
     }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "wingbot-mongodb",
-  "version": "4.2.5",
+  "version": "4.2.6",
   "description": "MongoDB storage for wingbot.ai",
   "main": "src/main.js",
   "scripts": {

package/src/BaseStorage.js

@@ -91,9 +91,8 @@ class BaseStorage {
         this._isCosmo = typeof isCosmo === 'number' || isCosmo;
         this._log = log;
 
-        /**
-         * @type {import('mongodb').Collection<T>|Promise<import('mongodb').Collection<T>>}
-         */
+        // eslint-disable-next-line max-len
+        /** @type {import('mongodb').Collection<wingbotmongodb.WithId<T>>|Promise<import('mongodb').Collection<wingbotmongodb.WithId<T>>>} */
         this._collection = null;
 
         this._indexes = [];
@@ -228,14 +227,14 @@ class BaseStorage {
     /**
      *
      * @param {string} name
-     * @returns {Promise<import('mongodb').Collection<T>>}
+     * @returns {Promise<import('mongodb').Collection<wingbotmongodb.WithId<T>>>}
      */
     async _getOrCreateCollection (name) {
         const db = typeof this._mongoDb === 'function'
             ? await this._mongoDb()
             : this._mongoDb;
 
-        /** @type {import('mongodb').Collection<T>} */
+        /** @type {import('mongodb').Collection<wingbotmongodb.WithId<T>>} */
         let collection;
 
         if (this._isCosmo) {
@@ -281,7 +280,7 @@ class BaseStorage {
      *
      * @protected
      * @param {boolean} [forRead]
-     * @returns {Promise<import('mongodb').Collection<T>>}
+     * @returns {Promise<import('mongodb').Collection<wingbotmongodb.WithId<T>>>}
      */
     async _getCollection (forRead = false) {
         if (this._collection === null) {
@@ -312,7 +311,7 @@ class BaseStorage {
     /**
      *
      * @param {object[]} indexes
-     * @param {import('mongodb').Collection<T>} collection
+     * @param {import('mongodb').Collection<wingbotmongodb.WithId<T>>} collection
      * @returns {Promise}
      */
     async _ensureIndexes (indexes, collection) {