@keyv/mongo 2.1.8 → 3.0.0-rc.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,22 @@
1
+ /// <reference types="node" />
2
+ import EventEmitter from 'events';
3
+ import { KeyvStoreAdapter, type StoredData } from 'keyv';
4
+ import { type KeyvMongoConnect, type KeyvMongoOptions, type Options } from './types';
5
+ declare class KeyvMongo extends EventEmitter implements KeyvStoreAdapter {
6
+ ttlSupport: boolean;
7
+ opts: Options;
8
+ connect: Promise<KeyvMongoConnect>;
9
+ namespace?: string;
10
+ constructor(url?: KeyvMongoOptions, options?: Options);
11
+ get<Value>(key: string): Promise<StoredData<Value>>;
12
+ getMany<Value>(keys: string[]): Promise<StoredData<Value>[]>;
13
+ set(key: string, value: any, ttl?: number): Promise<unknown>;
14
+ delete(key: string): Promise<boolean>;
15
+ deleteMany(keys: string[]): Promise<boolean>;
16
+ clear(): Promise<void>;
17
+ clearExpired(): Promise<boolean>;
18
+ clearUnusedFor(seconds: number): Promise<boolean>;
19
+ iterator(namespace?: string): AsyncGenerator<any[], void, void>;
20
+ has(key: string): Promise<boolean>;
21
+ }
22
+ export default KeyvMongo;
@@ -0,0 +1,253 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ const events_1 = __importDefault(require("events"));
7
+ const buffer_1 = require("buffer");
8
+ const mongodb_1 = require("mongodb");
9
+ const keyvMongoKeys = new Set(['url', 'collection', 'namespace', 'serialize', 'deserialize', 'uri', 'useGridFS', 'dialect']);
10
+ class KeyvMongo extends events_1.default {
11
+ ttlSupport = false;
12
+ opts;
13
+ connect;
14
+ namespace;
15
+ constructor(url, options) {
16
+ super();
17
+ url ??= {};
18
+ if (typeof url === 'string') {
19
+ url = { url };
20
+ }
21
+ if (url.uri) {
22
+ url = { url: url.uri, ...url };
23
+ }
24
+ this.opts = {
25
+ url: 'mongodb://127.0.0.1:27017',
26
+ collection: 'keyv',
27
+ ...url,
28
+ ...options,
29
+ };
30
+ delete this.opts.emitErrors;
31
+ const mongoOptions = Object.fromEntries(Object.entries(this.opts).filter(([k]) => !keyvMongoKeys.has(k)));
32
+ this.opts = Object.fromEntries(Object.entries(this.opts).filter(([k]) => keyvMongoKeys.has(k)));
33
+ // eslint-disable-next-line no-async-promise-executor
34
+ this.connect = new Promise(async (resolve, reject) => {
35
+ try {
36
+ let url = '';
37
+ if (this.opts.url) {
38
+ url = this.opts.url;
39
+ }
40
+ // eslint-disable-next-line new-cap
41
+ const client = new mongodb_1.MongoClient(url, mongoOptions);
42
+ await client.connect();
43
+ const database = client.db(this.opts.db);
44
+ if (this.opts.useGridFS) {
45
+ const bucket = new mongodb_1.GridFSBucket(database, {
46
+ readPreference: this.opts.readPreference,
47
+ bucketName: this.opts.collection,
48
+ });
49
+ const store = database.collection(`${this.opts.collection}.files`);
50
+ await store.createIndex({ uploadDate: -1 });
51
+ await store.createIndex({ 'metadata.expiresAt': 1 });
52
+ await store.createIndex({ 'metadata.lastAccessed': 1 });
53
+ resolve({ bucket, store, db: database });
54
+ }
55
+ else {
56
+ let collection = 'keyv';
57
+ if (this.opts.collection) {
58
+ collection = this.opts.collection;
59
+ }
60
+ const store = database.collection(collection);
61
+ await store.createIndex({ key: 1 }, { unique: true, background: true });
62
+ await store.createIndex({ expiresAt: 1 }, { expireAfterSeconds: 0, background: true });
63
+ resolve({ store });
64
+ }
65
+ }
66
+ catch (error) {
67
+ this.emit('error', error);
68
+ // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
69
+ reject(error);
70
+ }
71
+ });
72
+ }
73
+ async get(key) {
74
+ const client = await this.connect;
75
+ if (this.opts.useGridFS) {
76
+ await client.store.updateOne({
77
+ filename: key,
78
+ }, {
79
+ $set: {
80
+ 'metadata.lastAccessed': new Date(),
81
+ },
82
+ });
83
+ const stream = client.bucket.openDownloadStreamByName(key);
84
+ return new Promise(resolve => {
85
+ const resp = [];
86
+ stream.on('error', () => {
87
+ resolve(undefined);
88
+ });
89
+ stream.on('end', () => {
90
+ const data = buffer_1.Buffer.concat(resp).toString('utf8');
91
+ resolve(data);
92
+ });
93
+ stream.on('data', chunk => {
94
+ resp.push(chunk);
95
+ });
96
+ });
97
+ }
98
+ const document = await client.store.findOne({ key: { $eq: key } });
99
+ if (!document) {
100
+ return undefined;
101
+ }
102
+ return document.value;
103
+ }
104
+ async getMany(keys) {
105
+ if (this.opts.useGridFS) {
106
+ const promises = [];
107
+ for (const key of keys) {
108
+ promises.push(this.get(key));
109
+ }
110
+ const values = await Promise.allSettled(promises);
111
+ const data = [];
112
+ for (const value of values) {
113
+ // @ts-expect-error = value is PromiseFulfilledResult<Value>
114
+ data.push(value.value);
115
+ }
116
+ return data;
117
+ }
118
+ const connect = await this.connect;
119
+ // @ts-expect-error eslint-disable-next-line
120
+ const values = await connect.store.s.db.collection(this.opts.collection)
121
+ .find({ key: { $in: keys } })
122
+ .project({ _id: 0, value: 1, key: 1 })
123
+ .toArray();
124
+ const results = [...keys];
125
+ let i = 0;
126
+ for (const key of keys) {
127
+ const rowIndex = values.findIndex((row) => row.key === key);
128
+ // @ts-expect-error - results type
129
+ results[i] = rowIndex > -1 ? values[rowIndex].value : undefined;
130
+ i++;
131
+ }
132
+ return results;
133
+ }
134
+ async set(key, value, ttl) {
135
+ const expiresAt = typeof ttl === 'number' ? new Date(Date.now() + ttl) : null;
136
+ if (this.opts.useGridFS) {
137
+ const client = await this.connect;
138
+ const stream = client.bucket.openUploadStream(key, {
139
+ metadata: {
140
+ expiresAt,
141
+ lastAccessed: new Date(),
142
+ },
143
+ });
144
+ return new Promise(resolve => {
145
+ stream.on('finish', () => {
146
+ resolve(stream);
147
+ });
148
+ stream.end(value);
149
+ });
150
+ }
151
+ const client = await this.connect;
152
+ await client.store.updateOne({ key: { $eq: key } }, { $set: { key, value, expiresAt } }, { upsert: true });
153
+ }
154
+ async delete(key) {
155
+ if (typeof key !== 'string') {
156
+ return false;
157
+ }
158
+ const client = await this.connect;
159
+ if (this.opts.useGridFS) {
160
+ try {
161
+ const connection = client.db;
162
+ const bucket = new mongodb_1.GridFSBucket(connection, {
163
+ bucketName: this.opts.collection,
164
+ });
165
+ const files = await bucket.find({ filename: key }).toArray();
166
+ await client.bucket.delete(files[0]._id);
167
+ return true;
168
+ }
169
+ catch {
170
+ return false;
171
+ }
172
+ }
173
+ const object = await client.store.deleteOne({ key: { $eq: key } });
174
+ return object.deletedCount > 0;
175
+ }
176
+ async deleteMany(keys) {
177
+ const client = await this.connect;
178
+ if (this.opts.useGridFS) {
179
+ const connection = client.db;
180
+ const bucket = new mongodb_1.GridFSBucket(connection, {
181
+ bucketName: this.opts.collection,
182
+ });
183
+ const files = await bucket.find({ filename: { $in: keys } }).toArray();
184
+ if (files.length === 0) {
185
+ return false;
186
+ }
187
+ await Promise.all(files.map(async (file) => client.bucket.delete(file._id)));
188
+ return true;
189
+ }
190
+ const object = await client.store.deleteMany({ key: { $in: keys } });
191
+ return object.deletedCount > 0;
192
+ }
193
+ async clear() {
194
+ const client = await this.connect;
195
+ if (this.opts.useGridFS) {
196
+ await client.bucket.drop();
197
+ }
198
+ await client.store.deleteMany({
199
+ key: { $regex: this.namespace ? `^${this.namespace}:*` : '' },
200
+ });
201
+ }
202
+ async clearExpired() {
203
+ if (!this.opts.useGridFS) {
204
+ return false;
205
+ }
206
+ return this.connect.then(async (client) => {
207
+ const connection = client.db;
208
+ const bucket = new mongodb_1.GridFSBucket(connection, {
209
+ bucketName: this.opts.collection,
210
+ });
211
+ return bucket.find({
212
+ 'metadata.expiresAt': {
213
+ $lte: new Date(Date.now()),
214
+ },
215
+ }).toArray()
216
+ .then(async (expiredFiles) => Promise.all(expiredFiles.map(async (file) => client.bucket.delete(file._id))).then(() => true));
217
+ });
218
+ }
219
+ async clearUnusedFor(seconds) {
220
+ if (!this.opts.useGridFS) {
221
+ return false;
222
+ }
223
+ const client = await this.connect;
224
+ const connection = client.db;
225
+ const bucket = new mongodb_1.GridFSBucket(connection, {
226
+ bucketName: this.opts.collection,
227
+ });
228
+ const lastAccessedFiles = await bucket.find({
229
+ 'metadata.lastAccessed': {
230
+ $lte: new Date(Date.now() - (seconds * 1000)),
231
+ },
232
+ }).toArray();
233
+ await Promise.all(lastAccessedFiles.map(async (file) => client.bucket.delete(file._id)));
234
+ return true;
235
+ }
236
+ async *iterator(namespace) {
237
+ const client = await this.connect;
238
+ const iterator = client.store
239
+ .find({
240
+ key: new RegExp(`^${namespace ? namespace + ':' : '.*'}`),
241
+ })
242
+ .map((x) => [x.key, x.value]);
243
+ yield* iterator;
244
+ }
245
+ async has(key) {
246
+ const client = await this.connect;
247
+ const filter = { [this.opts.useGridFS ? 'filename' : 'key']: { $eq: key } };
248
+ const document = await client.store.count(filter);
249
+ return document !== 0;
250
+ }
251
+ }
252
+ exports.default = KeyvMongo;
253
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;;;AAAA,oDAAkC;AAClC,mCAA8B;AAC9B,qCAEiB;AASjB,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,SAAU,SAAQ,gBAAY;IACnC,UAAU,GAAG,KAAK,CAAC;IACnB,IAAI,CAAU;IACd,OAAO,CAA4B;IACnC,SAAS,CAAU;IAEnB,YAAY,GAAsB,EAAE,OAAiB;QACpD,KAAK,EAAE,CAAC;QACR,GAAG,KAAK,EAAE,CAAC;QACX,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC7B,GAAG,GAAG,EAAC,GAAG,EAAC,CAAC;QACb,CAAC;QAED,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;YACb,GAAG,GAAG,EAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,EAAC,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,IAAI,GAAG;YACX,GAAG,EAAE,2BAA2B;YAChC,UAAU,EAAE,MAAM;YAClB,GAAG,GAAG;YACN,GAAG,OAAO;SACV,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;QAE5B,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,qDAAqD;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,IAAI,CAAC;gBACJ,IAAI,GAAG,GAAG,EAAE,CAAC;gBACb,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;oBACnB,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;gBACrB,CAAC;gBAED,mCAAmC;gBACnC,MAAM,MAAM,GAAG,IAAI,qBAAW,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;gBAClD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;gBAEvB,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAEzC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACzB,MAAM,MAAM,GAAG,IAAI,sBAAY,CAAC,QAAQ,EAAE;wBACzC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc;wBACxC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;qBAChC,CAAC,CAAC;oBACH,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,QAAQ,CAAC,CAAC;oBAEnE,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,UAAU,EAAE,CAAC,CAAC,EAAC,CAAC,CAAC;oBAC1C,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,oBAAoB,EAAE,CAAC,EAAC,CAAC,CAAC;oBACnD,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,uBAAuB,EAAE,CAAC,EAAC,CAAC,CAAC;oBAEtD,OAAO,CAAC,EAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAC,CAAC,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACP,IAAI,UAAU,GAAG,MAAM,CAAC;oBACxB,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;wBAC1B,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;oBACnC,CAAC;oBAED,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;oBAE9C,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,GAAG,EAAE,CAAC,EAAC,EAAE,EAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAC,CAAC,CAAC;oBACpE,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,SAAS,EAAE,CAAC,EAAC,EAAE,EAAC,kBAAkB,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,EAAC,CAAC,CAAC;oBAEnF,OAAO,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC;gBAClB,CAAC;YACF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAC1B,2EAA2E;gBAC3E,MAAM,CAAC,KAAK,CAAC,CAAC;YACf,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAQ,GAAW;QAC3B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,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,IAAyB,CAAC,CAAC;gBACpC,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;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAC,GAAG,EAAE,EAAC,GAAG,EAAE,GAAG,EAAC,EAAC,CAAC,CAAC;QAE/D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACf,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,OAAO,QAAQ,CAAC,KAA0B,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,OAAO,CAAQ,IAAc;QAClC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9B,CAAC;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,CAAC;gBAC5B,4DAA4D;gBAC5D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAA0B,CAAC,CAAC;YAC7C,CAAC;YAED,OAAO,IAAI,CAAC;QACb,CAAC;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,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAkC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;YAE3F,kCAAkC;YAClC,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;QACL,CAAC;QAED,OAAO,OAAmC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,GAAY;QAC9C,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,CAAC;YACzB,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,KAAK,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,MAAM,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3B,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,CAAC;YAC7B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC;gBACJ,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;YACb,CAAC;YAAC,MAAM,CAAC;gBACR,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;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,CAAC;YACzB,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,CAAC;gBACxB,OAAO,KAAK,CAAC;YACd,CAAC;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;QACb,CAAC;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,CAAC;YACzB,MAAM,MAAM,CAAC,MAAO,CAAC,IAAI,EAAE,CAAC;QAC7B,CAAC;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,CAAC;YAC1B,OAAO,KAAK,CAAC;QACd,CAAC;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,CAAC;YAC1B,OAAO,KAAK,CAAC;QACd,CAAC;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,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClD,OAAO,QAAQ,KAAK,CAAC,CAAC;IACvB,CAAC;CACD;AAED,kBAAe,SAAS,CAAC"}
@@ -0,0 +1,21 @@
1
+ import { type Collection, type Db, type GridFSBucket, type ReadPreference } from 'mongodb';
2
+ export type Options = {
3
+ [key: string]: unknown;
4
+ url?: string | undefined;
5
+ collection?: string;
6
+ namespace?: string;
7
+ serialize?: any;
8
+ deserialize?: any;
9
+ useGridFS?: boolean;
10
+ uri?: string;
11
+ dialect?: string;
12
+ db?: string;
13
+ readPreference?: ReadPreference;
14
+ };
15
+ export type KeyvMongoOptions = Options | string;
16
+ export type KeyvMongoConnect = {
17
+ bucket?: GridFSBucket;
18
+ store: Collection;
19
+ db?: Db;
20
+ };
21
+ export type PifyFunction = (...arguments_: any[]) => any;
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}
@@ -0,0 +1,22 @@
1
+ /// <reference types="node" />
2
+ import EventEmitter from 'events';
3
+ import { KeyvStoreAdapter, type StoredData } from 'keyv';
4
+ import { type KeyvMongoConnect, type KeyvMongoOptions, type Options } from './types';
5
+ declare class KeyvMongo extends EventEmitter implements KeyvStoreAdapter {
6
+ ttlSupport: boolean;
7
+ opts: Options;
8
+ connect: Promise<KeyvMongoConnect>;
9
+ namespace?: string;
10
+ constructor(url?: KeyvMongoOptions, options?: Options);
11
+ get<Value>(key: string): Promise<StoredData<Value>>;
12
+ getMany<Value>(keys: string[]): Promise<StoredData<Value>[]>;
13
+ set(key: string, value: any, ttl?: number): Promise<unknown>;
14
+ delete(key: string): Promise<boolean>;
15
+ deleteMany(keys: string[]): Promise<boolean>;
16
+ clear(): Promise<void>;
17
+ clearExpired(): Promise<boolean>;
18
+ clearUnusedFor(seconds: number): Promise<boolean>;
19
+ iterator(namespace?: string): AsyncGenerator<any[], void, void>;
20
+ has(key: string): Promise<boolean>;
21
+ }
22
+ export default KeyvMongo;
@@ -0,0 +1,248 @@
1
+ import EventEmitter from 'events';
2
+ import { Buffer } from 'buffer';
3
+ import { MongoClient as mongoClient, GridFSBucket, } from 'mongodb';
4
+ const keyvMongoKeys = new Set(['url', 'collection', 'namespace', 'serialize', 'deserialize', 'uri', 'useGridFS', 'dialect']);
5
+ class KeyvMongo extends EventEmitter {
6
+ ttlSupport = false;
7
+ opts;
8
+ connect;
9
+ namespace;
10
+ constructor(url, options) {
11
+ super();
12
+ url ??= {};
13
+ if (typeof url === 'string') {
14
+ url = { url };
15
+ }
16
+ if (url.uri) {
17
+ url = { url: url.uri, ...url };
18
+ }
19
+ this.opts = {
20
+ url: 'mongodb://127.0.0.1:27017',
21
+ collection: 'keyv',
22
+ ...url,
23
+ ...options,
24
+ };
25
+ delete this.opts.emitErrors;
26
+ const mongoOptions = Object.fromEntries(Object.entries(this.opts).filter(([k]) => !keyvMongoKeys.has(k)));
27
+ this.opts = Object.fromEntries(Object.entries(this.opts).filter(([k]) => keyvMongoKeys.has(k)));
28
+ // eslint-disable-next-line no-async-promise-executor
29
+ this.connect = new Promise(async (resolve, reject) => {
30
+ try {
31
+ let url = '';
32
+ if (this.opts.url) {
33
+ url = this.opts.url;
34
+ }
35
+ // eslint-disable-next-line new-cap
36
+ const client = new mongoClient(url, mongoOptions);
37
+ await client.connect();
38
+ const database = client.db(this.opts.db);
39
+ if (this.opts.useGridFS) {
40
+ const bucket = new GridFSBucket(database, {
41
+ readPreference: this.opts.readPreference,
42
+ bucketName: this.opts.collection,
43
+ });
44
+ const store = database.collection(`${this.opts.collection}.files`);
45
+ await store.createIndex({ uploadDate: -1 });
46
+ await store.createIndex({ 'metadata.expiresAt': 1 });
47
+ await store.createIndex({ 'metadata.lastAccessed': 1 });
48
+ resolve({ bucket, store, db: database });
49
+ }
50
+ else {
51
+ let collection = 'keyv';
52
+ if (this.opts.collection) {
53
+ collection = this.opts.collection;
54
+ }
55
+ const store = database.collection(collection);
56
+ await store.createIndex({ key: 1 }, { unique: true, background: true });
57
+ await store.createIndex({ expiresAt: 1 }, { expireAfterSeconds: 0, background: true });
58
+ resolve({ store });
59
+ }
60
+ }
61
+ catch (error) {
62
+ this.emit('error', error);
63
+ // eslint-disable-next-line @typescript-eslint/prefer-promise-reject-errors
64
+ reject(error);
65
+ }
66
+ });
67
+ }
68
+ async get(key) {
69
+ const client = await this.connect;
70
+ if (this.opts.useGridFS) {
71
+ await client.store.updateOne({
72
+ filename: key,
73
+ }, {
74
+ $set: {
75
+ 'metadata.lastAccessed': new Date(),
76
+ },
77
+ });
78
+ const stream = client.bucket.openDownloadStreamByName(key);
79
+ return new Promise(resolve => {
80
+ const resp = [];
81
+ stream.on('error', () => {
82
+ resolve(undefined);
83
+ });
84
+ stream.on('end', () => {
85
+ const data = Buffer.concat(resp).toString('utf8');
86
+ resolve(data);
87
+ });
88
+ stream.on('data', chunk => {
89
+ resp.push(chunk);
90
+ });
91
+ });
92
+ }
93
+ const document = await client.store.findOne({ key: { $eq: key } });
94
+ if (!document) {
95
+ return undefined;
96
+ }
97
+ return document.value;
98
+ }
99
+ async getMany(keys) {
100
+ if (this.opts.useGridFS) {
101
+ const promises = [];
102
+ for (const key of keys) {
103
+ promises.push(this.get(key));
104
+ }
105
+ const values = await Promise.allSettled(promises);
106
+ const data = [];
107
+ for (const value of values) {
108
+ // @ts-expect-error = value is PromiseFulfilledResult<Value>
109
+ data.push(value.value);
110
+ }
111
+ return data;
112
+ }
113
+ const connect = await this.connect;
114
+ // @ts-expect-error eslint-disable-next-line
115
+ const values = await connect.store.s.db.collection(this.opts.collection)
116
+ .find({ key: { $in: keys } })
117
+ .project({ _id: 0, value: 1, key: 1 })
118
+ .toArray();
119
+ const results = [...keys];
120
+ let i = 0;
121
+ for (const key of keys) {
122
+ const rowIndex = values.findIndex((row) => row.key === key);
123
+ // @ts-expect-error - results type
124
+ results[i] = rowIndex > -1 ? values[rowIndex].value : undefined;
125
+ i++;
126
+ }
127
+ return results;
128
+ }
129
+ async set(key, value, ttl) {
130
+ const expiresAt = typeof ttl === 'number' ? new Date(Date.now() + ttl) : null;
131
+ if (this.opts.useGridFS) {
132
+ const client = await this.connect;
133
+ const stream = client.bucket.openUploadStream(key, {
134
+ metadata: {
135
+ expiresAt,
136
+ lastAccessed: new Date(),
137
+ },
138
+ });
139
+ return new Promise(resolve => {
140
+ stream.on('finish', () => {
141
+ resolve(stream);
142
+ });
143
+ stream.end(value);
144
+ });
145
+ }
146
+ const client = await this.connect;
147
+ await client.store.updateOne({ key: { $eq: key } }, { $set: { key, value, expiresAt } }, { upsert: true });
148
+ }
149
+ async delete(key) {
150
+ if (typeof key !== 'string') {
151
+ return false;
152
+ }
153
+ const client = await this.connect;
154
+ if (this.opts.useGridFS) {
155
+ try {
156
+ const connection = client.db;
157
+ const bucket = new GridFSBucket(connection, {
158
+ bucketName: this.opts.collection,
159
+ });
160
+ const files = await bucket.find({ filename: key }).toArray();
161
+ await client.bucket.delete(files[0]._id);
162
+ return true;
163
+ }
164
+ catch {
165
+ return false;
166
+ }
167
+ }
168
+ const object = await client.store.deleteOne({ key: { $eq: key } });
169
+ return object.deletedCount > 0;
170
+ }
171
+ async deleteMany(keys) {
172
+ const client = await this.connect;
173
+ if (this.opts.useGridFS) {
174
+ const connection = client.db;
175
+ const bucket = new GridFSBucket(connection, {
176
+ bucketName: this.opts.collection,
177
+ });
178
+ const files = await bucket.find({ filename: { $in: keys } }).toArray();
179
+ if (files.length === 0) {
180
+ return false;
181
+ }
182
+ await Promise.all(files.map(async (file) => client.bucket.delete(file._id)));
183
+ return true;
184
+ }
185
+ const object = await client.store.deleteMany({ key: { $in: keys } });
186
+ return object.deletedCount > 0;
187
+ }
188
+ async clear() {
189
+ const client = await this.connect;
190
+ if (this.opts.useGridFS) {
191
+ await client.bucket.drop();
192
+ }
193
+ await client.store.deleteMany({
194
+ key: { $regex: this.namespace ? `^${this.namespace}:*` : '' },
195
+ });
196
+ }
197
+ async clearExpired() {
198
+ if (!this.opts.useGridFS) {
199
+ return false;
200
+ }
201
+ return this.connect.then(async (client) => {
202
+ const connection = client.db;
203
+ const bucket = new GridFSBucket(connection, {
204
+ bucketName: this.opts.collection,
205
+ });
206
+ return bucket.find({
207
+ 'metadata.expiresAt': {
208
+ $lte: new Date(Date.now()),
209
+ },
210
+ }).toArray()
211
+ .then(async (expiredFiles) => Promise.all(expiredFiles.map(async (file) => client.bucket.delete(file._id))).then(() => true));
212
+ });
213
+ }
214
+ async clearUnusedFor(seconds) {
215
+ if (!this.opts.useGridFS) {
216
+ return false;
217
+ }
218
+ const client = await this.connect;
219
+ const connection = client.db;
220
+ const bucket = new GridFSBucket(connection, {
221
+ bucketName: this.opts.collection,
222
+ });
223
+ const lastAccessedFiles = await bucket.find({
224
+ 'metadata.lastAccessed': {
225
+ $lte: new Date(Date.now() - (seconds * 1000)),
226
+ },
227
+ }).toArray();
228
+ await Promise.all(lastAccessedFiles.map(async (file) => client.bucket.delete(file._id)));
229
+ return true;
230
+ }
231
+ async *iterator(namespace) {
232
+ const client = await this.connect;
233
+ const iterator = client.store
234
+ .find({
235
+ key: new RegExp(`^${namespace ? namespace + ':' : '.*'}`),
236
+ })
237
+ .map((x) => [x.key, x.value]);
238
+ yield* iterator;
239
+ }
240
+ async has(key) {
241
+ const client = await this.connect;
242
+ const filter = { [this.opts.useGridFS ? 'filename' : 'key']: { $eq: key } };
243
+ const document = await client.store.count(filter);
244
+ return document !== 0;
245
+ }
246
+ }
247
+ export default KeyvMongo;
248
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,QAAQ,CAAC;AAClC,OAAO,EAAC,MAAM,EAAC,MAAM,QAAQ,CAAC;AAC9B,OAAO,EACN,WAAW,IAAI,WAAW,EAAE,YAAY,GACxC,MAAM,SAAS,CAAC;AASjB,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,SAAU,SAAQ,YAAY;IACnC,UAAU,GAAG,KAAK,CAAC;IACnB,IAAI,CAAU;IACd,OAAO,CAA4B;IACnC,SAAS,CAAU;IAEnB,YAAY,GAAsB,EAAE,OAAiB;QACpD,KAAK,EAAE,CAAC;QACR,GAAG,KAAK,EAAE,CAAC;QACX,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC7B,GAAG,GAAG,EAAC,GAAG,EAAC,CAAC;QACb,CAAC;QAED,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;YACb,GAAG,GAAG,EAAC,GAAG,EAAE,GAAG,CAAC,GAAG,EAAE,GAAG,GAAG,EAAC,CAAC;QAC9B,CAAC;QAED,IAAI,CAAC,IAAI,GAAG;YACX,GAAG,EAAE,2BAA2B;YAChC,UAAU,EAAE,MAAM;YAClB,GAAG,GAAG;YACN,GAAG,OAAO;SACV,CAAC;QAEF,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;QAE5B,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,qDAAqD;QACrD,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,EAAE;YACpD,IAAI,CAAC;gBACJ,IAAI,GAAG,GAAG,EAAE,CAAC;gBACb,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;oBACnB,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC;gBACrB,CAAC;gBAED,mCAAmC;gBACnC,MAAM,MAAM,GAAG,IAAI,WAAW,CAAC,GAAG,EAAE,YAAY,CAAC,CAAC;gBAClD,MAAM,MAAM,CAAC,OAAO,EAAE,CAAC;gBAEvB,MAAM,QAAQ,GAAG,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAEzC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;oBACzB,MAAM,MAAM,GAAG,IAAI,YAAY,CAAC,QAAQ,EAAE;wBACzC,cAAc,EAAE,IAAI,CAAC,IAAI,CAAC,cAAc;wBACxC,UAAU,EAAE,IAAI,CAAC,IAAI,CAAC,UAAU;qBAChC,CAAC,CAAC;oBACH,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,QAAQ,CAAC,CAAC;oBAEnE,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,UAAU,EAAE,CAAC,CAAC,EAAC,CAAC,CAAC;oBAC1C,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,oBAAoB,EAAE,CAAC,EAAC,CAAC,CAAC;oBACnD,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,uBAAuB,EAAE,CAAC,EAAC,CAAC,CAAC;oBAEtD,OAAO,CAAC,EAAC,MAAM,EAAE,KAAK,EAAE,EAAE,EAAE,QAAQ,EAAC,CAAC,CAAC;gBACxC,CAAC;qBAAM,CAAC;oBACP,IAAI,UAAU,GAAG,MAAM,CAAC;oBACxB,IAAI,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;wBAC1B,UAAU,GAAG,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC;oBACnC,CAAC;oBAED,MAAM,KAAK,GAAG,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;oBAE9C,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,GAAG,EAAE,CAAC,EAAC,EAAE,EAAC,MAAM,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAC,CAAC,CAAC;oBACpE,MAAM,KAAK,CAAC,WAAW,CAAC,EAAC,SAAS,EAAE,CAAC,EAAC,EAAE,EAAC,kBAAkB,EAAE,CAAC,EAAE,UAAU,EAAE,IAAI,EAAC,CAAC,CAAC;oBAEnF,OAAO,CAAC,EAAC,KAAK,EAAC,CAAC,CAAC;gBAClB,CAAC;YACF,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBAChB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;gBAC1B,2EAA2E;gBAC3E,MAAM,CAAC,KAAK,CAAC,CAAC;YACf,CAAC;QACF,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,GAAG,CAAQ,GAAW;QAC3B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,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,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;oBAClD,OAAO,CAAC,IAAyB,CAAC,CAAC;gBACpC,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;QACJ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,EAAC,GAAG,EAAE,EAAC,GAAG,EAAE,GAAG,EAAC,EAAC,CAAC,CAAC;QAE/D,IAAI,CAAC,QAAQ,EAAE,CAAC;YACf,OAAO,SAAS,CAAC;QAClB,CAAC;QAED,OAAO,QAAQ,CAAC,KAA0B,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,OAAO,CAAQ,IAAc;QAClC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;YAC9B,CAAC;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,CAAC;gBAC5B,4DAA4D;gBAC5D,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAA0B,CAAC,CAAC;YAC7C,CAAC;YAED,OAAO,IAAI,CAAC;QACb,CAAC;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,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;QAC1B,IAAI,CAAC,GAAG,CAAC,CAAC;QACV,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,QAAQ,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,GAAkC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;YAE3F,kCAAkC;YAClC,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;QACL,CAAC;QAED,OAAO,OAAmC,CAAC;IAC5C,CAAC;IAED,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAU,EAAE,GAAY;QAC9C,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,CAAC;YACzB,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,KAAK,CAAC,CAAC;YACnB,CAAC,CAAC,CAAC;QACJ,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,MAAM,MAAM,CAAC,KAAK,CAAC,SAAS,CAC3B,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,CAAC;YAC7B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAElC,IAAI,IAAI,CAAC,IAAI,CAAC,SAAS,EAAE,CAAC;YACzB,IAAI,CAAC;gBACJ,MAAM,UAAU,GAAG,MAAM,CAAC,EAAG,CAAC;gBAC9B,MAAM,MAAM,GAAG,IAAI,YAAY,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;YACb,CAAC;YAAC,MAAM,CAAC;gBACR,OAAO,KAAK,CAAC;YACd,CAAC;QACF,CAAC;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,CAAC;YACzB,MAAM,UAAU,GAAG,MAAM,CAAC,EAAG,CAAC;YAC9B,MAAM,MAAM,GAAG,IAAI,YAAY,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,CAAC;gBACxB,OAAO,KAAK,CAAC;YACd,CAAC;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;QACb,CAAC;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,CAAC;YACzB,MAAM,MAAM,CAAC,MAAO,CAAC,IAAI,EAAE,CAAC;QAC7B,CAAC;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,CAAC;YAC1B,OAAO,KAAK,CAAC;QACd,CAAC;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,YAAY,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,CAAC;YAC1B,OAAO,KAAK,CAAC;QACd,CAAC;QAED,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC;QAClC,MAAM,UAAU,GAAG,MAAM,CAAC,EAAG,CAAC;QAC9B,MAAM,MAAM,GAAG,IAAI,YAAY,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,QAAQ,GAAG,MAAM,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;QAClD,OAAO,QAAQ,KAAK,CAAC,CAAC;IACvB,CAAC;CACD;AAED,eAAe,SAAS,CAAC"}
@@ -0,0 +1,21 @@
1
+ import { type Collection, type Db, type GridFSBucket, type ReadPreference } from 'mongodb';
2
+ export type Options = {
3
+ [key: string]: unknown;
4
+ url?: string | undefined;
5
+ collection?: string;
6
+ namespace?: string;
7
+ serialize?: any;
8
+ deserialize?: any;
9
+ useGridFS?: boolean;
10
+ uri?: string;
11
+ dialect?: string;
12
+ db?: string;
13
+ readPreference?: ReadPreference;
14
+ };
15
+ export type KeyvMongoOptions = Options | string;
16
+ export type KeyvMongoConnect = {
17
+ bucket?: GridFSBucket;
18
+ store: Collection;
19
+ db?: Db;
20
+ };
21
+ export type PifyFunction = (...arguments_: any[]) => any;
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=types.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}
package/package.json CHANGED
@@ -1,40 +1,44 @@
1
1
  {
2
2
  "name": "@keyv/mongo",
3
- "version": "2.1.8",
3
+ "version": "3.0.0-rc.1",
4
4
  "description": "MongoDB storage adapter for Keyv",
5
- "main": "src/index.js",
5
+ "main": "dist/cjs/index.js",
6
+ "type": "module",
7
+ "module": "dist/esm/index.js",
8
+ "types": "dist/esm/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "require": "./dist/cjs/index.js",
12
+ "import": "./dist/esm/index.js"
13
+ }
14
+ },
6
15
  "scripts": {
7
- "test": "xo && nyc ava --serial",
8
- "coverage": "nyc report --reporter=text-lcov > coverage.lcov",
9
- "clean": "rm -rf node_modules && rm -rf .nyc_output && rm -rf coverage.lcov"
16
+ "build": "rm -rf dist && tsc --project tsconfig.csj.json && tsc --project tsconfig.esm.json",
17
+ "prepare": "yarn build",
18
+ "test": "xo --fix && vitest run --coverage",
19
+ "test:ci": "xo && vitest --run --sequence.setupFiles=list",
20
+ "clean": "rm -rf node_modules && rm -rf ./coverage"
10
21
  },
11
22
  "xo": {
12
23
  "rules": {
13
- "unicorn/prefer-module": 0,
14
- "unicorn/no-array-reduce": 0,
15
- "unicorn/prefer-object-from-entries": 0,
16
- "unicorn/prefer-node-protocol": 0,
17
- "ava/no-ignored-test-files": [
18
- "error",
19
- {
20
- "extensions": [
21
- "js",
22
- "ts"
23
- ]
24
- }
25
- ]
24
+ "unicorn/prefer-module": "off",
25
+ "unicorn/prefer-event-target": "off",
26
+ "unicorn/no-array-reduce": "off",
27
+ "unicorn/prefer-object-from-entries": "off",
28
+ "unicorn/prefer-node-protocol": "off",
29
+ "@typescript-eslint/no-unsafe-assignment": "off",
30
+ "@typescript-eslint/no-unsafe-call": "off",
31
+ "@typescript-eslint/no-unsafe-return": "off",
32
+ "@typescript-eslint/no-unsafe-argument": "off",
33
+ "import/extensions": "off",
34
+ "@typescript-eslint/consistent-type-imports": "off",
35
+ "@typescript-eslint/naming-convention": "off",
36
+ "@typescript-eslint/no-floating-promises": "off",
37
+ "import/no-extraneous-dependencies": "off",
38
+ "@typescript-eslint/no-confusing-void-expression": "off",
39
+ "@typescript-eslint/no-empty-function": "off"
26
40
  }
27
41
  },
28
- "ava": {
29
- "require": [
30
- "requirable",
31
- "ts-node/register"
32
- ],
33
- "extensions": [
34
- "js",
35
- "ts"
36
- ]
37
- },
38
42
  "repository": {
39
43
  "type": "git",
40
44
  "url": "git+https://github.com/jaredwray/keyv.git"
@@ -58,27 +62,18 @@
58
62
  },
59
63
  "homepage": "https://github.com/jaredwray/keyv",
60
64
  "dependencies": {
61
- "mongodb": "^4.5.0",
62
- "pify": "^5.0.0"
65
+ "mongodb": "^6.6.2"
63
66
  },
64
67
  "devDependencies": {
65
68
  "@keyv/test-suite": "*",
66
- "ava": "^4.2.0",
67
- "keyv": "*",
68
- "nyc": "^15.1.0",
69
- "requirable": "^1.0.5",
70
- "this": "^1.1.0",
71
- "ts-node": "^10.8.2",
72
- "@types/keyv": "^3.1.4",
73
- "tsd": "^0.20.0",
74
- "typescript": "^4.6.4",
75
- "xo": "^0.48.0"
69
+ "keyv": "^5.0.0-rc.1",
70
+ "tsd": "^0.31.0",
71
+ "xo": "^0.58.0"
76
72
  },
77
- "tsd" : {
78
- "directory" : "test"
73
+ "tsd": {
74
+ "directory": "test"
79
75
  },
80
- "types": "./src/index.d.ts",
81
76
  "files": [
82
- "src"
77
+ "dist"
83
78
  ]
84
79
  }
package/src/index.d.ts DELETED
@@ -1,40 +0,0 @@
1
- import {EventEmitter} from 'events';
2
- import GridFSBucket from 'mongodb';
3
- import {Store, StoredData} from 'keyv';
4
-
5
- declare class KeyvMongo<Value=any> extends EventEmitter implements Store<Value> {
6
- readonly ttlSupport: false;
7
- opts: Record<string, any>;
8
- connect: Promise<any>;
9
- db: import('mongodb').Db;
10
- bucket: GridFSBucket;
11
- store: import('mongodb').Collection<import('bson').Document>;
12
- constructor(options?: string | KeyvMongo.Options);
13
- get(key: string): Promise<Value>;
14
- getMany?(
15
- keys: string[]
16
- ): Array<StoredData<Value>> | Promise<Array<StoredData<Value>>> | undefined;
17
- set(key: string, value: Value, ttl?: number): any;
18
- delete(key: string): boolean | Promise<boolean>;
19
- deleteMany(keys: string[]): boolean;
20
- clear(): void | Promise<void>;
21
- iterator(namespace: string | undefined): AsyncGenerator<any, void, any>;
22
- has?(key: string): boolean | Promise<boolean>;
23
- clearExpired(): boolean | Promise<boolean>;
24
- clearUnusedFor(seconds: any): boolean | Promise<boolean>;
25
- }
26
-
27
- export = KeyvMongo;
28
-
29
- declare namespace KeyvMongo {
30
- interface Options {
31
- url?: string | undefined;
32
- collection?: string | undefined;
33
- namespace?: string | undefined;
34
- serialize?: any;
35
- deserialize?: any;
36
- useGridFS?: boolean | undefined;
37
- uri?: string | undefined;
38
- dialect?: string | undefined;
39
- }
40
- }
package/src/index.js DELETED
@@ -1,359 +0,0 @@
1
- 'use strict';
2
-
3
- const EventEmitter = require('events');
4
- const {Buffer} = require('buffer');
5
- const mongoClient = require('mongodb').MongoClient;
6
- const {GridFSBucket} = require('mongodb');
7
- const pify = require('pify');
8
-
9
- const keyvMongoKeys = new Set(['url', 'collection', 'namespace', 'serialize', 'deserialize', 'uri', 'useGridFS', 'dialect']);
10
- class KeyvMongo extends EventEmitter {
11
- constructor(url, options) {
12
- super();
13
- this.ttlSupport = false;
14
- url = url || {};
15
- if (typeof url === 'string') {
16
- url = {url};
17
- }
18
-
19
- if (url.uri) {
20
- url = {url: url.uri, ...url};
21
- }
22
-
23
- this.opts = {
24
- url: 'mongodb://127.0.0.1:27017',
25
- collection: 'keyv',
26
- ...url,
27
- ...options,
28
- };
29
-
30
- const mongoOptions = Object.fromEntries(
31
- Object.entries(this.opts).filter(
32
- ([k]) => !keyvMongoKeys.has(k),
33
- ),
34
- );
35
-
36
- this.opts = Object.fromEntries(
37
- Object.entries(this.opts).filter(
38
- ([k]) => keyvMongoKeys.has(k),
39
- ),
40
- );
41
-
42
- // Implementation from sql by lukechilds,
43
- this.connect = new Promise(resolve => {
44
- mongoClient.connect(this.opts.url, mongoOptions, (error, client) => {
45
- if (error) {
46
- return this.emit('error', error);
47
- }
48
-
49
- this.db = client.db(this.opts.db);
50
- if (this.opts.useGridFS) {
51
- this.bucket = new GridFSBucket(this.db, {
52
- readPreference: this.opts.readPreference || 'primary',
53
- bucketName: this.opts.collection,
54
- });
55
- this.store = this.db.collection(this.opts.collection + '.files');
56
- this.store.createIndex({
57
- filename: 'hashed',
58
- });
59
- this.store.createIndex({
60
- uploadDate: -1,
61
- });
62
- this.store.createIndex({
63
- 'metadata.expiresAt': 1,
64
- });
65
- this.store.createIndex({
66
- 'metadata.lastAccessed': 1,
67
- });
68
-
69
- for (const method of [
70
- 'updateOne',
71
- 'count',
72
- ]) {
73
- this.store[method] = pify(this.store[method].bind(this.store));
74
- }
75
-
76
- for (const method of [
77
- 'find',
78
- 'drop',
79
- ]) {
80
- this.bucket[method] = pify(this.bucket[method].bind(this.bucket));
81
- }
82
-
83
- resolve({bucket: this.bucket, store: this.store, db: this.db});
84
- } else {
85
- this.store = this.db.collection(this.opts.collection);
86
- this.store.createIndex(
87
- {key: 1},
88
- {
89
- unique: true,
90
- background: true,
91
- },
92
- );
93
- this.store.createIndex(
94
- {expiresAt: 1},
95
- {
96
- expireAfterSeconds: 0,
97
- background: true,
98
- },
99
- );
100
-
101
- for (const method of [
102
- 'updateOne',
103
- 'findOne',
104
- 'deleteOne',
105
- 'deleteMany',
106
- 'count',
107
- ]) {
108
- this.store[method] = pify(this.store[method].bind(this.store));
109
- }
110
-
111
- resolve(this.store);
112
- }
113
- });
114
- });
115
- }
116
-
117
- get(key) {
118
- if (this.opts.useGridFS) {
119
- return this.connect.then(client => {
120
- client.store.updateOne({
121
- filename: key,
122
- }, {
123
- $set: {
124
- 'metadata.lastAccessed': new Date(),
125
- },
126
- });
127
-
128
- const stream = client.bucket.openDownloadStreamByName(key);
129
- return new Promise(resolve => {
130
- let resp = [];
131
- stream.on('error', () => resolve());
132
-
133
- stream.on('end', () => {
134
- resp = Buffer.concat(resp).toString('utf-8');
135
- resolve(resp);
136
- });
137
-
138
- stream.on('data', chunk => {
139
- resp.push(chunk);
140
- });
141
- });
142
- });
143
- }
144
-
145
- return this.connect.then(store =>
146
- store.findOne({key: {$eq: key}}).then(doc => {
147
- if (!doc) {
148
- return undefined;
149
- }
150
-
151
- return doc.value;
152
- }),
153
- );
154
- }
155
-
156
- getMany(keys) {
157
- if (this.opts.useGridFS) {
158
- const promises = [];
159
- for (const key of keys) {
160
- promises.push(this.get(key));
161
- }
162
-
163
- return Promise.allSettled(promises)
164
- .then(values => {
165
- const data = [];
166
- for (const value of values) {
167
- data.push(value.value);
168
- }
169
-
170
- return data;
171
- });
172
- }
173
-
174
- const results = [...keys];
175
- return this.connect.then(store =>
176
- store.s.db.collection(this.opts.collection)
177
- .find({key: {$in: keys}})
178
- .project({_id: 0, value: 1, key: 1})
179
- .toArray().then(values => {
180
- let i = 0;
181
- for (const key of keys) {
182
- const rowIndex = values.findIndex(row => row.key === key);
183
-
184
- if (rowIndex > -1) {
185
- results[i] = values[rowIndex].value;
186
- } else {
187
- results[i] = undefined;
188
- }
189
-
190
- i++;
191
- }
192
-
193
- return results;
194
- }),
195
- );
196
- }
197
-
198
- set(key, value, ttl) {
199
- const expiresAt = typeof ttl === 'number' ? new Date(Date.now() + ttl) : null;
200
-
201
- if (this.opts.useGridFS) {
202
- return this.connect.then(client => {
203
- const stream = client.bucket.openUploadStream(key, {
204
- metadata: {
205
- expiresAt,
206
- lastAccessed: new Date(),
207
- },
208
- });
209
-
210
- return new Promise(resolve => {
211
- stream.on('finish', () => {
212
- resolve(stream);
213
- });
214
- stream.end(value);
215
- });
216
- });
217
- }
218
-
219
- return this.connect.then(store =>
220
- store.updateOne(
221
- {key: {$eq: key}},
222
- {$set: {key, value, expiresAt}},
223
- {upsert: true},
224
- ),
225
- );
226
- }
227
-
228
- delete(key) {
229
- if (typeof key !== 'string') {
230
- return Promise.resolve(false);
231
- }
232
-
233
- if (this.opts.useGridFS) {
234
- return this.connect.then(client => {
235
- const connection = client.db;
236
- const bucket = new GridFSBucket(connection, {
237
- bucketName: this.opts.collection,
238
- });
239
- return bucket.find({filename: key}).toArray()
240
- .then(files => client.bucket.delete(files[0]._id).then(() => true))
241
- .catch(() => false);
242
- });
243
- }
244
-
245
- return this.connect.then(store =>
246
- store
247
- .deleteOne({key: {$eq: key}})
248
- .then(object => object.deletedCount > 0),
249
- );
250
- }
251
-
252
- deleteMany(keys) {
253
- if (this.opts.useGridFS) {
254
- return this.connect.then(client => {
255
- const connection = client.db;
256
- const bucket = new GridFSBucket(connection, {
257
- bucketName: this.opts.collection,
258
- });
259
- return bucket.find({filename: {$in: keys}}).toArray()
260
- .then(
261
- files => {
262
- if (files.length === 0) {
263
- return false;
264
- }
265
-
266
- files.map(file => client.bucket.delete(file._id));
267
- return true;
268
- });
269
- });
270
- }
271
-
272
- return this.connect.then(store =>
273
- store
274
- .deleteMany({key: {$in: keys}})
275
- .then(object => object.deletedCount > 0),
276
- );
277
- }
278
-
279
- clear() {
280
- if (this.opts.useGridFS) {
281
- return this.connect.then(client => client.bucket.drop().then(() => undefined));
282
- }
283
-
284
- return this.connect.then(store =>
285
- store
286
- .deleteMany({
287
- key: {$regex: this.namespace ? `^${this.namespace}:*` : ''},
288
- })
289
- .then(() => undefined),
290
- );
291
- }
292
-
293
- clearExpired() {
294
- if (!this.opts.useGridFS) {
295
- return false;
296
- }
297
-
298
- return this.connect.then(client => {
299
- const connection = client.db;
300
- const bucket = new GridFSBucket(connection, {
301
- bucketName: this.opts.collection,
302
- });
303
-
304
- return bucket.find({
305
- 'metadata.expiresAt': {
306
- $lte: new Date(Date.now()),
307
- },
308
- }).toArray()
309
- .then(expiredFiles => Promise.all(expiredFiles.map(file => client.bucket.delete(file._id))).then(() => true));
310
- });
311
- }
312
-
313
- clearUnusedFor(seconds) {
314
- if (!this.opts.useGridFS) {
315
- return false;
316
- }
317
-
318
- return this.connect.then(client => {
319
- const connection = client.db;
320
- const bucket = new GridFSBucket(connection, {
321
- bucketName: this.opts.collection,
322
- });
323
-
324
- return bucket.find({
325
- 'metadata.lastAccessed': {
326
- $lte: new Date(Date.now() - (seconds * 1000)),
327
- },
328
- }).toArray()
329
- .then(lastAccessedFiles => Promise.all(lastAccessedFiles.map(file => client.bucket.delete(file._id))).then(() => true));
330
- });
331
- }
332
-
333
- async * iterator(namespace) {
334
- const iterator = await this.connect.then(store =>
335
- store
336
- .find({
337
- key: new RegExp(`^${namespace ? namespace + ':' : '.*'}`),
338
- })
339
- .map(x => [x.key, x.value]),
340
- );
341
- yield * iterator;
342
- }
343
-
344
- has(key) {
345
- if (this.opts.useGridFS) {
346
- return this.connect.then(client => client.store.count(
347
- {filename: {$eq: key}},
348
- ).then(doc => doc !== 0));
349
- }
350
-
351
- return this.connect.then(store =>
352
- store.count(
353
- {key: {$eq: key}},
354
- ),
355
- ).then(doc => doc !== 0);
356
- }
357
- }
358
-
359
- module.exports = KeyvMongo;