@keyv/mongo 2.1.8 → 2.2.8

package/dist/index.d.ts

@@ -0,0 +1,21 @@
+/// <reference types="node" />
+import EventEmitter from 'events';
+import { type ClearExpiredOutput, type ClearOutput, type ClearUnusedForOutput, type DeleteManyOutput, type DeleteOutput, type GetManyOutput, type GetOutput, type HasOutput, type KeyvMongoConnect, type KeyvMongoOptions, type Options, type SetOutput } from './types';
+declare class KeyvMongo<Value = any> extends EventEmitter {
+    ttlSupport: boolean;
+    opts: Options;
+    connect: Promise<KeyvMongoConnect>;
+    namespace?: string;
+    constructor(url?: KeyvMongoOptions, options?: Options);
+    get(key: string): GetOutput<Value>;
+    getMany(keys: string[]): GetManyOutput<Value>;
+    set(key: string, value: Value, ttl?: number): SetOutput;
+    delete(key: string): DeleteOutput;
+    deleteMany(keys: string[]): DeleteManyOutput;
+    clear(): ClearOutput;
+    clearExpired(): ClearExpiredOutput;
+    clearUnusedFor(seconds: number): ClearUnusedForOutput;
+    iterator(namespace?: string): AsyncGenerator<any[], void, undefined>;
+    has(key: string): HasOutput;
+}
+export = KeyvMongo;

package/dist/index.js

@@ -0,0 +1,272 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+const events_1 = __importDefault(require("events"));
+const buffer_1 = require("buffer");
+const mongodb_1 = require("mongodb");
+const pify_1 = __importDefault(require("pify"));
+const keyvMongoKeys = new Set(['url', 'collection', 'namespace', 'serialize', 'deserialize', 'uri', 'useGridFS', 'dialect']);
+class KeyvMongo extends events_1.default {
+    constructor(url, options) {
+        super();
+        this.ttlSupport = false;
+        url = url ?? {};
+        if (typeof url === 'string') {
+            url = { url };
+        }
+        if (url.uri) {
+            url = { url: url.uri, ...url };
+        }
+        this.opts = {
+            url: 'mongodb://127.0.0.1:27017',
+            collection: 'keyv',
+            ...url,
+            ...options,
+        };
+        const mongoOptions = Object.fromEntries(Object.entries(this.opts).filter(([k]) => !keyvMongoKeys.has(k)));
+        this.opts = Object.fromEntries(Object.entries(this.opts).filter(([k]) => keyvMongoKeys.has(k)));
+        // Implementation from sql by lukechilds,
+        this.connect = new Promise(resolve => {
+            mongodb_1.MongoClient.connect(this.opts.url, mongoOptions, (error, client) => {
+                if (error) {
+                    return this.emit('error', error);
+                }
+                const db = client.db(this.opts.db);
+                if (this.opts.useGridFS) {
+                    const bucket = new mongodb_1.GridFSBucket(db, {
+                        readPreference: this.opts.readPreference,
+                        bucketName: this.opts.collection,
+                    });
+                    const store = db.collection(`${this.opts.collection}.files`);
+                    store.createIndex({
+                        uploadDate: -1,
+                    });
+                    store.createIndex({
+                        'metadata.expiresAt': 1,
+                    });
+                    store.createIndex({
+                        'metadata.lastAccessed': 1,
+                    });
+                    for (const method of [
+                        'updateOne',
+                        'count',
+                    ]) {
+                        // @ts-expect-error - method needs to be a string
+                        store[method] = (0, pify_1.default)(store[method].bind(store));
+                    }
+                    for (const method of [
+                        'find',
+                        'drop',
+                    ]) {
+                        // @ts-expect-error - method needs to be a string
+                        bucket[method] = (0, pify_1.default)(bucket[method].bind(bucket));
+                    }
+                    resolve({ bucket, store, db });
+                }
+                else {
+                    const store = db.collection(this.opts.collection);
+                    store.createIndex({ key: 1 }, {
+                        unique: true,
+                        background: true,
+                    });
+                    store.createIndex({ expiresAt: 1 }, {
+                        expireAfterSeconds: 0,
+                        background: true,
+                    });
+                    for (const method of [
+                        'updateOne',
+                        'findOne',
+                        'deleteOne',
+                        'deleteMany',
+                        'count',
+                    ]) {
+                        // @ts-expect-error - method needs to be a string
+                        store[method] = (0, pify_1.default)(store[method].bind(store));
+                    }
+                    resolve({ store });
+                }
+            });
+        });
+    }
+    async get(key) {
+        if (this.opts.useGridFS) {
+            const client = await this.connect;
+            await client.store.updateOne({
+                filename: key,
+            }, {
+                $set: {
+                    'metadata.lastAccessed': new Date(),
+                },
+            });
+            const stream = client.bucket.openDownloadStreamByName(key);
+            return new Promise(resolve => {
+                const resp = [];
+                stream.on('error', () => {
+                    resolve(undefined);
+                });
+                stream.on('end', () => {
+                    const data = buffer_1.Buffer.concat(resp).toString('utf8');
+                    resolve(data);
+                });
+                stream.on('data', chunk => {
+                    resp.push(chunk);
+                });
+            });
+        }
+        const connect = await this.connect;
+        const doc = await connect.store.findOne({ key: { $eq: key } });
+        if (!doc) {
+            return undefined;
+        }
+        return doc.value;
+    }
+    async getMany(keys) {
+        if (this.opts.useGridFS) {
+            const promises = [];
+            for (const key of keys) {
+                promises.push(this.get(key));
+            }
+            const values = await Promise.allSettled(promises);
+            const data = [];
+            for (const value of values) {
+                // @ts-expect-error = value is PromiseFulfilledResult<Value>
+                data.push(value.value);
+            }
+            return data;
+        }
+        const connect = await this.connect;
+        // @ts-expect-error eslint-disable-next-line
+        const values = await connect.store.s.db.collection(this.opts.collection)
+            .find({ key: { $in: keys } })
+            .project({ _id: 0, value: 1, key: 1 })
+            .toArray();
+        const results = [...keys];
+        let i = 0;
+        for (const key of keys) {
+            const rowIndex = values.findIndex((row) => row.key === key);
+            results[i] = rowIndex > -1 ? values[rowIndex].value : undefined;
+            i++;
+        }
+        return results;
+    }
+    async set(key, value, ttl) {
+        const expiresAt = typeof ttl === 'number' ? new Date(Date.now() + ttl) : null;
+        if (this.opts.useGridFS) {
+            const client = await this.connect;
+            const stream = client.bucket.openUploadStream(key, {
+                metadata: {
+                    expiresAt,
+                    lastAccessed: new Date(),
+                },
+            });
+            return new Promise(resolve => {
+                stream.on('finish', () => {
+                    resolve(stream);
+                });
+                stream.end(value);
+            });
+        }
+        const client = await this.connect;
+        return client.store.updateOne({ key: { $eq: key } }, { $set: { key, value, expiresAt } }, { upsert: true });
+    }
+    async delete(key) {
+        if (typeof key !== 'string') {
+            return false;
+        }
+        const client = await this.connect;
+        if (this.opts.useGridFS) {
+            try {
+                const connection = client.db;
+                const bucket = new mongodb_1.GridFSBucket(connection, {
+                    bucketName: this.opts.collection,
+                });
+                const files = await bucket.find({ filename: key }).toArray();
+                await client.bucket.delete(files[0]._id);
+                return true;
+            }
+            catch {
+                return false;
+            }
+        }
+        const object = await client.store.deleteOne({ key: { $eq: key } });
+        return object.deletedCount > 0;
+    }
+    async deleteMany(keys) {
+        const client = await this.connect;
+        if (this.opts.useGridFS) {
+            const connection = client.db;
+            const bucket = new mongodb_1.GridFSBucket(connection, {
+                bucketName: this.opts.collection,
+            });
+            const files = await bucket.find({ filename: { $in: keys } }).toArray();
+            if (files.length === 0) {
+                return false;
+            }
+            await Promise.all(files.map(async (file) => client.bucket.delete(file._id)));
+            return true;
+        }
+        const object = await client.store.deleteMany({ key: { $in: keys } });
+        return object.deletedCount > 0;
+    }
+    async clear() {
+        const client = await this.connect;
+        if (this.opts.useGridFS) {
+            await client.bucket.drop();
+        }
+        await client.store.deleteMany({
+            key: { $regex: this.namespace ? `^${this.namespace}:*` : '' },
+        });
+    }
+    async clearExpired() {
+        if (!this.opts.useGridFS) {
+            return false;
+        }
+        return this.connect.then(async (client) => {
+            const connection = client.db;
+            const bucket = new mongodb_1.GridFSBucket(connection, {
+                bucketName: this.opts.collection,
+            });
+            return bucket.find({
+                'metadata.expiresAt': {
+                    $lte: new Date(Date.now()),
+                },
+            }).toArray()
+                .then(async (expiredFiles) => Promise.all(expiredFiles.map(async (file) => client.bucket.delete(file._id))).then(() => true));
+        });
+    }
+    async clearUnusedFor(seconds) {
+        if (!this.opts.useGridFS) {
+            return false;
+        }
+        const client = await this.connect;
+        const connection = client.db;
+        const bucket = new mongodb_1.GridFSBucket(connection, {
+            bucketName: this.opts.collection,
+        });
+        const lastAccessedFiles = await bucket.find({
+            'metadata.lastAccessed': {
+                $lte: new Date(Date.now() - (seconds * 1000)),
+            },
+        }).toArray();
+        await Promise.all(lastAccessedFiles.map(async (file) => client.bucket.delete(file._id)));
+        return true;
+    }
+    async *iterator(namespace) {
+        const client = await this.connect;
+        const iterator = client.store
+            .find({
+            key: new RegExp(`^${namespace ? namespace + ':' : '.*'}`),
+        })
+            .map((x) => [x.key, x.value]);
+        yield* iterator;
+    }
+    async has(key) {
+        const client = await this.connect;
+        const filter = { [this.opts.useGridFS ? 'filename' : 'key']: { $eq: key } };
+        const doc = await client.store.count(filter);
+        return doc !== 0;
+    }
+}
+module.exports = KeyvMongo;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;AAAA,oDAAkC;AAClC,mCAA8B;AAC9B,qCAA6F;AAC7F,gDAAwB;AAexB,MAAM,aAAa,GAAG,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,EAAE,WAAW,EAAE,aAAa,EAAE,KAAK,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC,CAAC;AAC7H,MAAM,SAAuB,SAAQ,gBAAY;IAMhD,YAAY,GAAsB,EAAE,OAAiB;QACpD,KAAK,EAAE,CAAC;QANT,eAAU,GAAG,KAAK,CAAC;QAOlB,GAAG,GAAG,GAAG,IAAI,EAAE,CAAC;QAChB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC5B,GAAG,GAAG,EAAC,GAAG,EAAC,CAAC;SACZ;QAED,IAAI,GAAG,CAAC,GAAG,EAAE;YACZ,GAAG,GAAG,EAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,EAAC,CAAC;SAC7B;QAED,IAAI,CAAC,IAAI,GAAG;YACX,GAAG,EAAE,2BAA2B;YAChC,UAAU,EAAE,MAAM;YAClB,GAAG,GAAG;YACN,GAAG,OAAO;SACV,CAAC;QAEF,MAAM,YAAY,GAAG,MAAM,CAAC,WAAW,CACtC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAC/B,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAC9B,CACD,CAAC;QAEF,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,WAAW,CAC7B,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,CAC/B,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAC7B,CACD,CAAC;QAEF,yCAAyC;QACzC,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;YACpC,qBAAW,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAI,EAAE,YAAY,EAAE,CAAC,KAAK,EAAE,MAAM,EAAE,EAAE;gBACnE,IAAI,KAAK,EAAE;oBACV,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;iBACjC;gBAED,MAAM,EAAE,GAAG,MAAO,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAEpC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;oBACxB,MAAM,MAAM,GAAG,IAAI,sBAAY,CAAC,EAAE,EAAE;wBACnC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc;wBACxC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;qBAChC,CAAC,CAAC;oBACH,MAAM,KAAK,GAAG,EAAE,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,UAAW,QAAQ,CAAC,CAAC;oBAC9D,KAAK,CAAC,WAAW,CAAC;wBACjB,UAAU,EAAE,CAAC,CAAC;qBACd,CAAC,CAAC;oBACH,KAAK,CAAC,WAAW,CAAC;wBACjB,oBAAoB,EAAE,CAAC;qBACvB,CAAC,CAAC;oBACH,KAAK,CAAC,WAAW,CAAC;wBACjB,uBAAuB,EAAE,CAAC;qBAC1B,CAAC,CAAC;oBAEH,KAAK,MAAM,MAAM,IAAI;wBACpB,WAAW;wBACX,OAAO;qBACP,EAAE;wBACF,iDAAiD;wBACjD,KAAK,CAAC,MAAM,CAAC,GAAG,IAAA,cAAI,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAiB,CAAC,CAAC;qBAChE;oBAED,KAAK,MAAM,MAAM,IAAI;wBACpB,MAAM;wBACN,MAAM;qBACN,EAAE;wBACF,iDAAiD;wBACjD,MAAM,CAAC,MAAM,CAAC,GAAG,IAAA,cAAI,EAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,MAAM,CAAiB,CAAC,CAAC;qBACnE;oBAED,OAAO,CAAC,EAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAC,CAAC,CAAC;iBAC7B;qBAAM;oBACN,MAAM,KAAK,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAW,CAAC,CAAC;oBACnD,KAAK,CAAC,WAAW,CAChB,EAAC,GAAG,EAAE,CAAC,EAAC,EACR;wBACC,MAAM,EAAE,IAAI;wBACZ,UAAU,EAAE,IAAI;qBAChB,CACD,CAAC;oBACF,KAAK,CAAC,WAAW,CAChB,EAAC,SAAS,EAAE,CAAC,EAAC,EACd;wBACC,kBAAkB,EAAE,CAAC;wBACrB,UAAU,EAAE,IAAI;qBAChB,CACD,CAAC;oBAEF,KAAK,MAAM,MAAM,IAAI;wBACpB,WAAW;wBACX,SAAS;wBACT,WAAW;wBACX,YAAY;wBACZ,OAAO;qBACP,EAAE;wBACF,iDAAiD;wBACjD,KAAK,CAAC,MAAM,CAAC,GAAG,IAAA,cAAI,EAAC,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,KAAK,CAAiB,CAAC,CAAC;qBAChE;oBAED,OAAO,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC;iBACjB;YACF,CAAC,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACpB,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACxB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAClC,MAAM,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC;gBAC5B,QAAQ,EAAE,GAAG;aACb,EAAE;gBACF,IAAI,EAAE;oBACL,uBAAuB,EAAE,IAAI,IAAI,EAAE;iBACnC;aACD,CAAC,CAAC;YAEH,MAAM,MAAM,GAAG,MAAM,CAAC,MAAO,CAAC,wBAAwB,CAAC,GAAG,CAAC,CAAC;YAE5D,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;gBAC5B,MAAM,IAAI,GAAiB,EAAE,CAAC;gBAC9B,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;oBACvB,OAAO,CAAC,SAAS,CAAC,CAAC;gBACpB,CAAC,CAAC,CAAC;gBAEH,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBACrB,MAAM,IAAI,GAAG,eAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAClD,OAAO,CAAC,IAAa,CAAC,CAAC;gBACxB,CAAC,CAAC,CAAC;gBAEH,MAAM,CAAC,EAAE,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE;oBACzB,IAAI,CAAC,IAAI,CAAC,KAAmB,CAAC,CAAC;gBAChC,CAAC,CAAC,CAAC;YACJ,CAAC,CAAC,CAAC;SACH;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QACnC,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,EAAC,GAAG,EAAE,EAAC,GAAG,EAAE,GAAG,EAAC,EAAC,CAAC,CAAC;QAE3D,IAAI,CAAC,GAAG,EAAE;YACT,OAAO,SAAS,CAAC;SACjB;QAED,OAAO,GAAG,CAAC,KAAc,CAAC;IAC3B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,IAAc;QAC3B,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACxB,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;gBACvB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;aAC7B;YAED,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;YAClD,MAAM,IAAI,GAA6B,EAAE,CAAC;YAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;gBAC3B,4DAA4D;gBAC5D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAA0B,CAAC,CAAC;aAC5C;YAED,OAAO,IAAI,CAAC;SACZ;QAED,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QACnC,4CAA4C;QAC5C,MAAM,MAAM,GAAmD,MAAM,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,UAAW,CAAC;aACvH,IAAI,CAAC,EAAC,GAAG,EAAE,EAAC,GAAG,EAAE,IAAI,EAAC,EAAC,CAAC;aACxB,OAAO,CAAC,EAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,EAAE,GAAG,EAAE,CAAC,EAAC,CAAC;aACnC,OAAO,EAAE,CAAC;QAEZ,MAAM,OAAO,GAA6B,CAAC,GAAG,IAAI,CAAC,CAAC;QACpD,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACvB,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAkC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;YAE3F,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;YAEhE,CAAC,EAAE,CAAC;SACJ;QAED,OAAO,OAAO,CAAC;IAChB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAY,EAAE,GAAY;QAChD,MAAM,SAAS,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAE9E,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACxB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;YAClC,MAAM,MAAM,GAAG,MAAM,CAAC,MAAO,CAAC,gBAAgB,CAAC,GAAG,EAAE;gBACnD,QAAQ,EAAE;oBACT,SAAS;oBACT,YAAY,EAAE,IAAI,IAAI,EAAE;iBACxB;aACD,CAAC,CAAC;YAEH,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE;gBAC5B,MAAM,CAAC,EAAE,CAAC,QAAQ,EAAE,GAAG,EAAE;oBACxB,OAAO,CAAC,MAAM,CAAC,CAAC;gBACjB,CAAC,CAAC,CAAC;gBACH,MAAM,CAAC,GAAG,CAAC,KAAY,CAAC,CAAC;YAC1B,CAAC,CAAC,CAAC;SACH;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,OAAO,MAAM,CAAC,KAAK,CAAC,SAAS,CAC5B,EAAC,GAAG,EAAE,EAAC,GAAG,EAAE,GAAG,EAAC,EAAC,EACjB,EAAC,IAAI,EAAE,EAAC,GAAG,EAAE,KAAK,EAAE,SAAS,EAAC,EAAC,EAC/B,EAAC,MAAM,EAAE,IAAI,EAAC,CACd,CAAC;IACH,CAAC;IAED,KAAK,CAAC,MAAM,CAAC,GAAW;QACvB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC5B,OAAO,KAAK,CAAC;SACb;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACxB,IAAI;gBACH,MAAM,UAAU,GAAG,MAAM,CAAC,EAAG,CAAC;gBAC9B,MAAM,MAAM,GAAG,IAAI,sBAAY,CAAC,UAAU,EAAE;oBAC3C,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;iBAChC,CAAC,CAAC;gBACH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,EAAC,QAAQ,EAAE,GAAG,EAAC,CAAC,CAAC,OAAO,EAAE,CAAC;gBAC3D,MAAM,MAAM,CAAC,MAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;gBAC1C,OAAO,IAAI,CAAC;aACZ;YAAC,MAAM;gBACP,OAAO,KAAK,CAAC;aACb;SACD;QAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,SAAS,CAAC,EAAC,GAAG,EAAE,EAAC,GAAG,EAAE,GAAG,EAAC,EAAC,CAAC,CAAC;QAC/D,OAAO,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,UAAU,CAAC,IAAc;QAC9B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACxB,MAAM,UAAU,GAAG,MAAM,CAAC,EAAG,CAAC;YAC9B,MAAM,MAAM,GAAG,IAAI,sBAAY,CAAC,UAAU,EAAE;gBAC3C,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;aAChC,CAAC,CAAC;YACH,MAAM,KAAK,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,EAAC,QAAQ,EAAE,EAAC,GAAG,EAAE,IAAI,EAAC,EAAC,CAAC,CAAC,OAAO,EAAE,CAAC;YACnE,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE;gBACvB,OAAO,KAAK,CAAC;aACb;YAED,MAAM,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE,CAAC,MAAM,CAAC,MAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;YAC5E,OAAO,IAAI,CAAC;SACZ;QAED,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,EAAC,GAAG,EAAE,EAAC,GAAG,EAAE,IAAI,EAAC,EAAC,CAAC,CAAC;QACjE,OAAO,MAAM,CAAC,YAAY,GAAG,CAAC,CAAC;IAChC,CAAC;IAED,KAAK,CAAC,KAAK;QACV,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACxB,MAAM,MAAM,CAAC,MAAO,CAAC,IAAI,EAAE,CAAC;SAC5B;QAED,MAAM,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;YAC7B,GAAG,EAAE,EAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,EAAE,EAAC;SAC3D,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,YAAY;QACjB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACzB,OAAO,KAAK,CAAC;SACb;QAED,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,EAAC,MAAM,EAAC,EAAE;YACvC,MAAM,UAAU,GAAG,MAAM,CAAC,EAAG,CAAC;YAC9B,MAAM,MAAM,GAAG,IAAI,sBAAY,CAAC,UAAU,EAAE;gBAC3C,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;aAChC,CAAC,CAAC;YAEH,OAAO,MAAM,CAAC,IAAI,CAAC;gBAClB,oBAAoB,EAAE;oBACrB,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;iBAC1B;aACD,CAAC,CAAC,OAAO,EAAE;iBACV,IAAI,CAAC,KAAK,EAAC,YAAY,EAAC,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE,CAAC,MAAM,CAAC,MAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC;QAC7H,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,cAAc,CAAC,OAAe;QACnC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE;YACzB,OAAO,KAAK,CAAC;SACb;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,MAAM,UAAU,GAAG,MAAM,CAAC,EAAG,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,sBAAY,CAAC,UAAU,EAAE;YAC3C,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;SAChC,CAAC,CAAC;QAEH,MAAM,iBAAiB,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC;YAC3C,uBAAuB,EAAE;gBACxB,IAAI,EAAE,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;aAC7C;SACD,CAAC,CAAC,OAAO,EAAE,CAAC;QAEb,MAAM,OAAO,CAAC,GAAG,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,EAAC,IAAI,EAAC,EAAE,CAAC,MAAM,CAAC,MAAO,CAAC,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACxF,OAAO,IAAI,CAAC;IACb,CAAC;IAED,KAAK,CAAC,CAAE,QAAQ,CAAC,SAAkB;QAClC,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK;aAC3B,IAAI,CAAC;YACL,GAAG,EAAE,IAAI,MAAM,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;SACzD,CAAC;aACD,GAAG,CAAC,CAAC,CAAmB,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAEjD,KAAM,CAAC,CAAC,QAAQ,CAAC;IAClB,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW;QACpB,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,MAAM,MAAM,GAAG,EAAC,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,EAAE,EAAC,GAAG,EAAE,GAAG,EAAC,EAAC,CAAC;QACxE,MAAM,GAAG,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAC7C,OAAO,GAAG,KAAK,CAAC,CAAC;IAClB,CAAC;CACD;AAED,iBAAS,SAAS,CAAC"}

package/dist/types.d.ts

@@ -0,0 +1,31 @@
+import { type Collection, type Db, type GridFSBucket, type ReadPreference } from 'mongodb';
+import { type StoredData } from 'keyv';
+export type Options = {
+    [key: string]: unknown;
+    url?: string | undefined;
+    collection?: string;
+    namespace?: string;
+    serialize?: any;
+    deserialize?: any;
+    useGridFS?: boolean;
+    uri?: string;
+    dialect?: string;
+    db?: string;
+    readPreference?: ReadPreference;
+};
+export type KeyvMongoOptions = Options | string;
+export type KeyvMongoConnect = {
+    bucket?: GridFSBucket;
+    store: Collection;
+    db?: Db;
+};
+export type PifyFunction = (...args: any[]) => any;
+export type GetOutput<Value> = Promise<Value | undefined>;
+export type GetManyOutput<Value> = Promise<Array<StoredData<Value | undefined>>>;
+export type SetOutput = Promise<any>;
+export type DeleteOutput = Promise<boolean>;
+export type DeleteManyOutput = Promise<boolean>;
+export type ClearOutput = Promise<void>;
+export type ClearExpiredOutput = Promise<boolean>;
+export type ClearUnusedForOutput = Promise<boolean>;
+export type HasOutput = Promise<boolean>;

package/dist/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -1,12 +1,15 @@
 {
 	"name": "@keyv/mongo",
-	"version": "2.1.8",
+	"version": "2.2.8",
 	"description": "MongoDB storage adapter for Keyv",
-	"main": "src/index.js",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
 	"scripts": {
-		"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"
+		"build": "tsc --project tsconfig.dist.json",
+		"prepare": "yarn build",
+		"test": "xo && c8 ava --serial",
+		"test:ci": "xo && ava --serial",
+		"clean": "rm -rf node_modules && rm -rf ./coverage"
 	},
 	"xo": {
 		"rules": {
@@ -14,6 +17,12 @@
 			"unicorn/no-array-reduce": 0,
 			"unicorn/prefer-object-from-entries": 0,
 			"unicorn/prefer-node-protocol": 0,
+			"@typescript-eslint/no-unsafe-assignment": 0,
+			"@typescript-eslint/no-unsafe-call": 0,
+			"@typescript-eslint/no-unsafe-return": 0,
+			"@typescript-eslint/no-unsafe-argument": 0,
+			"import/extensions": 0,
+			"@typescript-eslint/consistent-type-imports": 0,
 			"ava/no-ignored-test-files": [
 				"error",
 				{
@@ -22,16 +31,17 @@
 						"ts"
 					]
 				}
-			]
+			],
+			"@typescript-eslint/naming-convention": 0,
+			"@typescript-eslint/no-floating-promises": 0,
+			" @typescript-eslint/no-unsafe-argument": 0
 		}
 	},
 	"ava": {
 		"require": [
-			"requirable",
 			"ts-node/register"
 		],
 		"extensions": [
-			"js",
 			"ts"
 		]
 	},
@@ -63,22 +73,17 @@
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"ava": "^4.2.0",
+		"@ava/typescript": "^4.0.0",
+		"@types/pify": "^5.0.1",
 		"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.4",
-		"xo": "^0.48.0"
+		"tsd": "^0.28.1"
 	},
-	"tsd" : {
-		"directory" : "test"
+	"tsd": {
+		"directory": "test"
 	},
-	"types": "./src/index.d.ts",
 	"files": [
-		"src"
+		"dist"
 	]
 }

package/src/index.d.ts

@@ -1,40 +0,0 @@
-import {EventEmitter} from 'events';
-import GridFSBucket from 'mongodb';
-import {Store, StoredData} from 'keyv';
-
-declare class KeyvMongo<Value=any> extends EventEmitter implements Store<Value> {
-	readonly ttlSupport: false;
-	opts: Record<string, any>;
-	connect: Promise<any>;
-	db: import('mongodb').Db;
-	bucket: GridFSBucket;
-	store: import('mongodb').Collection<import('bson').Document>;
-	constructor(options?: string | KeyvMongo.Options);
-	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;
-	clear(): void | Promise<void>;
-	iterator(namespace: string | undefined): AsyncGenerator<any, void, any>;
-	has?(key: string): boolean | Promise<boolean>;
-	clearExpired(): boolean | Promise<boolean>;
-	clearUnusedFor(seconds: any): boolean | Promise<boolean>;
-}
-
-export = KeyvMongo;
-
-declare namespace KeyvMongo {
-	interface Options {
-		url?: string | undefined;
-		collection?: string | undefined;
-		namespace?: string | undefined;
-		serialize?: any;
-		deserialize?: any;
-		useGridFS?: boolean | undefined;
-		uri?: string | undefined;
-		dialect?: string | undefined;
-	}
-}

package/src/index.js

@@ -1,359 +0,0 @@
-'use strict';
-
-const EventEmitter = require('events');
-const {Buffer} = require('buffer');
-const mongoClient = require('mongodb').MongoClient;
-const {GridFSBucket} = require('mongodb');
-const pify = require('pify');
-
-const keyvMongoKeys = new Set(['url', 'collection', 'namespace', 'serialize', 'deserialize', 'uri', 'useGridFS', 'dialect']);
-class KeyvMongo extends EventEmitter {
-	constructor(url, options) {
-		super();
-		this.ttlSupport = false;
-		url = url || {};
-		if (typeof url === 'string') {
-			url = {url};
-		}
-
-		if (url.uri) {
-			url = {url: url.uri, ...url};
-		}
-
-		this.opts = {
-			url: 'mongodb://127.0.0.1:27017',
-			collection: 'keyv',
-			...url,
-			...options,
-		};
-
-		const mongoOptions = Object.fromEntries(
-			Object.entries(this.opts).filter(
-				([k]) => !keyvMongoKeys.has(k),
-			),
-		);
-
-		this.opts = Object.fromEntries(
-			Object.entries(this.opts).filter(
-				([k]) => keyvMongoKeys.has(k),
-			),
-		);
-
-		// 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,
-					});
-
-					for (const method of [
-						'updateOne',
-						'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({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);
-				}
-			});
-		});
-	}
-
-	get(key) {
-		if (this.opts.useGridFS) {
-			return this.connect.then(client => {
-				client.store.updateOne({
-					filename: key,
-				}, {
-					$set: {
-						'metadata.lastAccessed': new Date(),
-					},
-				});
-
-				const stream = client.bucket.openDownloadStreamByName(key);
-				return new Promise(resolve => {
-					let resp = [];
-					stream.on('error', () => resolve());
-
-					stream.on('end', () => {
-						resp = Buffer.concat(resp).toString('utf-8');
-						resolve(resp);
-					});
-
-					stream.on('data', chunk => {
-						resp.push(chunk);
-					});
-				});
-			});
-		}
-
-		return this.connect.then(store =>
-			store.findOne({key: {$eq: key}}).then(doc => {
-				if (!doc) {
-					return undefined;
-				}
-
-				return doc.value;
-			}),
-		);
-	}
-
-	getMany(keys) {
-		if (this.opts.useGridFS) {
-			const promises = [];
-			for (const key of keys) {
-				promises.push(this.get(key));
-			}
-
-			return Promise.allSettled(promises)
-				.then(values => {
-					const data = [];
-					for (const value of values) {
-						data.push(value.value);
-					}
-
-					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})
-				.toArray().then(values => {
-					let i = 0;
-					for (const key of keys) {
-						const rowIndex = values.findIndex(row => row.key === key);
-
-						if (rowIndex > -1) {
-							results[i] = values[rowIndex].value;
-						} else {
-							results[i] = undefined;
-						}
-
-						i++;
-					}
-
-					return results;
-				}),
-		);
-	}
-
-	set(key, value, ttl) {
-		const expiresAt = typeof ttl === 'number' ? new Date(Date.now() + ttl) : null;
-
-		if (this.opts.useGridFS) {
-			return this.connect.then(client => {
-				const stream = client.bucket.openUploadStream(key, {
-					metadata: {
-						expiresAt,
-						lastAccessed: new Date(),
-					},
-				});
-
-				return new Promise(resolve => {
-					stream.on('finish', () => {
-						resolve(stream);
-					});
-					stream.end(value);
-				});
-			});
-		}
-
-		return this.connect.then(store =>
-			store.updateOne(
-				{key: {$eq: key}},
-				{$set: {key, value, expiresAt}},
-				{upsert: true},
-			),
-		);
-	}
-
-	delete(key) {
-		if (typeof key !== 'string') {
-			return Promise.resolve(false);
-		}
-
-		if (this.opts.useGridFS) {
-			return this.connect.then(client => {
-				const connection = client.db;
-				const bucket = new GridFSBucket(connection, {
-					bucketName: this.opts.collection,
-				});
-				return bucket.find({filename: key}).toArray()
-					.then(files => client.bucket.delete(files[0]._id).then(() => true))
-					.catch(() => false);
-			});
-		}
-
-		return this.connect.then(store =>
-			store
-				.deleteOne({key: {$eq: key}})
-				.then(object => object.deletedCount > 0),
-		);
-	}
-
-	deleteMany(keys) {
-		if (this.opts.useGridFS) {
-			return this.connect.then(client => {
-				const connection = client.db;
-				const bucket = new GridFSBucket(connection, {
-					bucketName: this.opts.collection,
-				});
-				return bucket.find({filename: {$in: keys}}).toArray()
-					.then(
-						files => {
-							if (files.length === 0) {
-								return false;
-							}
-
-							files.map(file => client.bucket.delete(file._id));
-							return true;
-						});
-			});
-		}
-
-		return this.connect.then(store =>
-			store
-				.deleteMany({key: {$in: keys}})
-				.then(object => object.deletedCount > 0),
-		);
-	}
-
-	clear() {
-		if (this.opts.useGridFS) {
-			return this.connect.then(client => client.bucket.drop().then(() => undefined));
-		}
-
-		return this.connect.then(store =>
-			store
-				.deleteMany({
-					key: {$regex: this.namespace ? `^${this.namespace}:*` : ''},
-				})
-				.then(() => undefined),
-		);
-	}
-
-	clearExpired() {
-		if (!this.opts.useGridFS) {
-			return false;
-		}
-
-		return this.connect.then(client => {
-			const connection = client.db;
-			const bucket = new GridFSBucket(connection, {
-				bucketName: this.opts.collection,
-			});
-
-			return bucket.find({
-				'metadata.expiresAt': {
-					$lte: new Date(Date.now()),
-				},
-			}).toArray()
-				.then(expiredFiles => Promise.all(expiredFiles.map(file => client.bucket.delete(file._id))).then(() => true));
-		});
-	}
-
-	clearUnusedFor(seconds) {
-		if (!this.opts.useGridFS) {
-			return false;
-		}
-
-		return this.connect.then(client => {
-			const connection = client.db;
-			const bucket = new GridFSBucket(connection, {
-				bucketName: this.opts.collection,
-			});
-
-			return bucket.find({
-				'metadata.lastAccessed': {
-					$lte: new Date(Date.now() - (seconds * 1000)),
-				},
-			}).toArray()
-				.then(lastAccessedFiles => Promise.all(lastAccessedFiles.map(file => client.bucket.delete(file._id))).then(() => true));
-		});
-	}
-
-	async * iterator(namespace) {
-		const iterator = await this.connect.then(store =>
-			store
-				.find({
-					key: new RegExp(`^${namespace ? namespace + ':' : '.*'}`),
-				})
-				.map(x => [x.key, x.value]),
-		);
-		yield * iterator;
-	}
-
-	has(key) {
-		if (this.opts.useGridFS) {
-			return this.connect.then(client => client.store.count(
-				{filename: {$eq: key}},
-			).then(doc => doc !== 0));
-		}
-
-		return this.connect.then(store =>
-			store.count(
-				{key: {$eq: key}},
-			),
-		).then(doc => doc !== 0);
-	}
-}
-
-module.exports = KeyvMongo;