@keyv/mongo 2.1.5 → 2.1.8

package/README.md

@@ -3,8 +3,9 @@
 > MongoDB storage adapter for Keyv
 
 [![build](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml/badge.svg)](https://github.com/jaredwray/keyv/actions/workflows/tests.yaml)
-[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/master/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
+[![codecov](https://codecov.io/gh/jaredwray/keyv/branch/main/graph/badge.svg?token=bRzR3RyOXZ)](https://codecov.io/gh/jaredwray/keyv)
 [![npm](https://img.shields.io/npm/v/@keyv/mongo.svg)](https://www.npmjs.com/package/@keyv/mongo)
+[![npm](https://img.shields.io/npm/dm/@keyv/mongo)](https://npmjs.com/package/@keyv/mongo)
 
 MongoDB storage adapter for [Keyv](https://github.com/jaredwray/keyv).
 
@@ -35,4 +36,4 @@ const keyv = new Keyv('mongodb://user:pass@localhost:27017/dbname', { collection
 
 ## License
 
-MIT © Jared Wray & Luke Childs
+MIT © Jared Wray

package/package.json

@@ -1,24 +1,38 @@
 {
 	"name": "@keyv/mongo",
-	"version": "2.1.5",
+	"version": "2.1.8",
 	"description": "MongoDB storage adapter for Keyv",
 	"main": "src/index.js",
 	"scripts": {
-		"test": "xo && nyc ava",
+		"test": "xo && nyc ava --serial",
 		"coverage": "nyc report --reporter=text-lcov > coverage.lcov",
 		"clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov"
 	},
 	"xo": {
-		"extends": "xo-lukechilds",
 		"rules": {
 			"unicorn/prefer-module": 0,
 			"unicorn/no-array-reduce": 0,
-			"unicorn/prefer-object-from-entries": 0
+			"unicorn/prefer-object-from-entries": 0,
+			"unicorn/prefer-node-protocol": 0,
+			"ava/no-ignored-test-files": [
+				"error",
+				{
+					"extensions": [
+						"js",
+						"ts"
+					]
+				}
+			]
 		}
 	},
 	"ava": {
 		"require": [
-			"requirable"
+			"requirable",
+			"ts-node/register"
+		],
+		"extensions": [
+			"js",
+			"ts"
 		]
 	},
 	"repository": {
@@ -44,19 +58,20 @@
 	},
 	"homepage": "https://github.com/jaredwray/keyv",
 	"dependencies": {
-		"mongodb": "^4.4.1",
+		"mongodb": "^4.5.0",
 		"pify": "^5.0.0"
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"ava": "^4.1.0",
-		"eslint-config-xo-lukechilds": "^1.0.1",
+		"ava": "^4.2.0",
 		"keyv": "*",
 		"nyc": "^15.1.0",
 		"requirable": "^1.0.5",
 		"this": "^1.1.0",
+		"ts-node": "^10.8.2",
+		"@types/keyv": "^3.1.4",
 		"tsd": "^0.20.0",
-		"typescript": "^4.6.3",
+		"typescript": "^4.6.4",
 		"xo": "^0.48.0"
 	},
 	"tsd" : {

package/src/index.d.ts

@@ -1,7 +1,8 @@
-import EventEmitter from 'node:events';
+import {EventEmitter} from 'events';
 import GridFSBucket from 'mongodb';
+import {Store, StoredData} from 'keyv';
 
-declare class KeyvMongo extends EventEmitter {
+declare class KeyvMongo<Value=any> extends EventEmitter implements Store<Value> {
 	readonly ttlSupport: false;
 	opts: Record<string, any>;
 	connect: Promise<any>;
@@ -9,16 +10,18 @@ declare class KeyvMongo extends EventEmitter {
 	bucket: GridFSBucket;
 	store: import('mongodb').Collection<import('bson').Document>;
 	constructor(options?: string | KeyvMongo.Options);
-	get(key: string): Promise<string | undefined>;
-	getMany(keys: string[]): Promise<string[] | undefined>;
-	set(key: string, value: string | undefined): Promise<any>;
-	delete(key: string): boolean;
+	get(key: string): Promise<Value>;
+	getMany?(
+		keys: string[]
+	): Array<StoredData<Value>> | Promise<Array<StoredData<Value>>> | undefined;
+	set(key: string, value: Value, ttl?: number): any;
+	delete(key: string): boolean | Promise<boolean>;
 	deleteMany(keys: string[]): boolean;
-	clearExpired(): false | Promise<boolean>;
-	clearUnusedFor(seconds: any): false | Promise<boolean>;
-	clear(): Promise<void>;
+	clear(): void | Promise<void>;
 	iterator(namespace: string | undefined): AsyncGenerator<any, void, any>;
-	has(key: string): boolean;
+	has?(key: string): boolean | Promise<boolean>;
+	clearExpired(): boolean | Promise<boolean>;
+	clearUnusedFor(seconds: any): boolean | Promise<boolean>;
 }
 
 export = KeyvMongo;

package/src/index.js

@@ -1,10 +1,9 @@
-// @ts-ignore
 'use strict';
 
 const EventEmitter = require('events');
-const { Buffer } = require('buffer');
+const {Buffer} = require('buffer');
 const mongoClient = require('mongodb').MongoClient;
-const { GridFSBucket } = require('mongodb');
+const {GridFSBucket} = require('mongodb');
 const pify = require('pify');
 
 const keyvMongoKeys = new Set(['url', 'collection', 'namespace', 'serialize', 'deserialize', 'uri', 'useGridFS', 'dialect']);
@@ -14,11 +13,11 @@ class KeyvMongo extends EventEmitter {
 		this.ttlSupport = false;
 		url = url || {};
 		if (typeof url === 'string') {
-			url = { url };
+			url = {url};
 		}
 
 		if (url.uri) {
-			url = { url: url.uri, ...url };
+			url = {url: url.uri, ...url};
 		}
 
 		this.opts = {
@@ -42,77 +41,76 @@ class KeyvMongo extends EventEmitter {
 
 		// Implementation from sql by lukechilds,
 		this.connect = new Promise(resolve => {
-			mongoClient.connect(this.opts.url, mongoOptions
-				, (error, client) => {
-					if (error) {
-						return this.emit('error', error);
-					}
-
-					this.db = client.db(this.opts.db);
-					if (this.opts.useGridFS) {
-						this.bucket = new GridFSBucket(this.db, {
-							readPreference: this.opts.readPreference || 'primary',
-							bucketName: this.opts.collection,
-						});
-						this.store = this.db.collection(this.opts.collection + '.files');
-						this.store.createIndex({
-							filename: 'hashed',
-						});
-						this.store.createIndex({
-							uploadDate: -1,
-						});
-						this.store.createIndex({
-							'metadata.expiresAt': 1,
-						});
-						this.store.createIndex({
-							'metadata.lastAccessed': 1,
-						});
+			mongoClient.connect(this.opts.url, mongoOptions, (error, client) => {
+				if (error) {
+					return this.emit('error', error);
+				}
 
-						for (const method of [
-							'updateOne',
-							'count',
-						]) {
-							this.store[method] = pify(this.store[method].bind(this.store));
-						}
+				this.db = client.db(this.opts.db);
+				if (this.opts.useGridFS) {
+					this.bucket = new GridFSBucket(this.db, {
+						readPreference: this.opts.readPreference || 'primary',
+						bucketName: this.opts.collection,
+					});
+					this.store = this.db.collection(this.opts.collection + '.files');
+					this.store.createIndex({
+						filename: 'hashed',
+					});
+					this.store.createIndex({
+						uploadDate: -1,
+					});
+					this.store.createIndex({
+						'metadata.expiresAt': 1,
+					});
+					this.store.createIndex({
+						'metadata.lastAccessed': 1,
+					});
 
-						for (const method of [
-							'find',
-							'drop',
-						]) {
-							this.bucket[method] = pify(this.bucket[method].bind(this.bucket));
-						}
+					for (const method of [
+						'updateOne',
+						'count',
+					]) {
+						this.store[method] = pify(this.store[method].bind(this.store));
+					}
 
-						resolve({ bucket: this.bucket, store: this.store, db: this.db });
-					} else {
-						this.store = this.db.collection(this.opts.collection);
-						this.store.createIndex(
-							{ key: 1 },
-							{
-								unique: true,
-								background: true,
-							},
-						);
-						this.store.createIndex(
-							{ expiresAt: 1 },
-							{
-								expireAfterSeconds: 0,
-								background: true,
-							},
-						);
-
-						for (const method of [
-							'updateOne',
-							'findOne',
-							'deleteOne',
-							'deleteMany',
-							'count',
-						]) {
-							this.store[method] = pify(this.store[method].bind(this.store));
-						}
+					for (const method of [
+						'find',
+						'drop',
+					]) {
+						this.bucket[method] = pify(this.bucket[method].bind(this.bucket));
+					}
 
-						resolve(this.store);
+					resolve({bucket: this.bucket, store: this.store, db: this.db});
+				} else {
+					this.store = this.db.collection(this.opts.collection);
+					this.store.createIndex(
+						{key: 1},
+						{
+							unique: true,
+							background: true,
+						},
+					);
+					this.store.createIndex(
+						{expiresAt: 1},
+						{
+							expireAfterSeconds: 0,
+							background: true,
+						},
+					);
+
+					for (const method of [
+						'updateOne',
+						'findOne',
+						'deleteOne',
+						'deleteMany',
+						'count',
+					]) {
+						this.store[method] = pify(this.store[method].bind(this.store));
 					}
-				});
+
+					resolve(this.store);
+				}
+			});
 		});
 	}
 
@@ -145,7 +143,7 @@ class KeyvMongo extends EventEmitter {
 		}
 
 		return this.connect.then(store =>
-			store.findOne({ key: { $eq: key } }).then(doc => {
+			store.findOne({key: {$eq: key}}).then(doc => {
 				if (!doc) {
 					return undefined;
 				}
@@ -169,15 +167,15 @@ class KeyvMongo extends EventEmitter {
 						data.push(value.value);
 					}
 
-					return data.every(x => x === undefined) ? [] : data;
+					return data;
 				});
 		}
 
 		const results = [...keys];
 		return this.connect.then(store =>
 			store.s.db.collection(this.opts.collection)
-				.find({ key: { $in: keys } })
-				.project({ _id: 0, value: 1, key: 1 })
+				.find({key: {$in: keys}})
+				.project({_id: 0, value: 1, key: 1})
 				.toArray().then(values => {
 					let i = 0;
 					for (const key of keys) {
@@ -192,7 +190,7 @@ class KeyvMongo extends EventEmitter {
 						i++;
 					}
 
-					return results.every(x => x === undefined) ? [] : results;
+					return results;
 				}),
 		);
 	}
@@ -220,9 +218,9 @@ class KeyvMongo extends EventEmitter {
 
 		return this.connect.then(store =>
 			store.updateOne(
-				{ key: { $eq: key } },
-				{ $set: { key, value, expiresAt } },
-				{ upsert: true },
+				{key: {$eq: key}},
+				{$set: {key, value, expiresAt}},
+				{upsert: true},
 			),
 		);
 	}
@@ -238,7 +236,7 @@ class KeyvMongo extends EventEmitter {
 				const bucket = new GridFSBucket(connection, {
 					bucketName: this.opts.collection,
 				});
-				return bucket.find({ filename: key }).toArray()
+				return bucket.find({filename: key}).toArray()
 					.then(files => client.bucket.delete(files[0]._id).then(() => true))
 					.catch(() => false);
 			});
@@ -246,7 +244,7 @@ class KeyvMongo extends EventEmitter {
 
 		return this.connect.then(store =>
 			store
-				.deleteOne({ key: { $eq: key } })
+				.deleteOne({key: {$eq: key}})
 				.then(object => object.deletedCount > 0),
 		);
 	}
@@ -258,7 +256,7 @@ class KeyvMongo extends EventEmitter {
 				const bucket = new GridFSBucket(connection, {
 					bucketName: this.opts.collection,
 				});
-				return bucket.find({ filename: { $in: keys } }).toArray()
+				return bucket.find({filename: {$in: keys}}).toArray()
 					.then(
 						files => {
 							if (files.length === 0) {
@@ -273,7 +271,7 @@ class KeyvMongo extends EventEmitter {
 
 		return this.connect.then(store =>
 			store
-				.deleteMany({ key: { $in: keys } })
+				.deleteMany({key: {$in: keys}})
 				.then(object => object.deletedCount > 0),
 		);
 	}
@@ -286,7 +284,7 @@ class KeyvMongo extends EventEmitter {
 		return this.connect.then(store =>
 			store
 				.deleteMany({
-					key: { $regex: this.namespace ? `^${this.namespace}:*` : '' },
+					key: {$regex: this.namespace ? `^${this.namespace}:*` : ''},
 				})
 				.then(() => undefined),
 		);
@@ -346,13 +344,13 @@ class KeyvMongo extends EventEmitter {
 	has(key) {
 		if (this.opts.useGridFS) {
 			return this.connect.then(client => client.store.count(
-				{ filename: { $eq: key } },
+				{filename: {$eq: key}},
 			).then(doc => doc !== 0));
 		}
 
 		return this.connect.then(store =>
 			store.count(
-				{ key: { $eq: key } },
+				{key: {$eq: key}},
 			),
 		).then(doc => doc !== 0);
 	}