@keyv/etcd 1.1.5 → 1.2.0

package/dist/index.d.ts

@@ -0,0 +1,29 @@
+/// <reference types="node" />
+import { EventEmitter } from 'events';
+import type { Lease } from 'etcd3';
+import { Etcd3 } from 'etcd3';
+import type { Store, StoredData } from 'keyv';
+type KeyvEtcdOptions = {
+    url?: string;
+    uri?: string;
+    ttl?: number;
+    busyTimeout?: number;
+};
+type GetOutput<Value> = Value | Promise<Value | undefined> | undefined;
+declare class KeyvEtcd<Value = any> extends EventEmitter implements Store<Value> {
+    ttlSupport: boolean;
+    opts: KeyvEtcdOptions;
+    client: Etcd3;
+    lease?: Lease;
+    namespace?: string;
+    constructor(url?: KeyvEtcdOptions | string, options?: KeyvEtcdOptions);
+    get(key: string): GetOutput<Value>;
+    getMany(keys: string[]): Promise<Array<StoredData<Value>>>;
+    set(key: string, value: Value): import("etcd3").PutBuilder;
+    delete(key: string): Promise<boolean>;
+    deleteMany(keys: string[]): Promise<boolean>;
+    clear(): Promise<void>;
+    has(key: string): Promise<boolean>;
+    disconnect(): void;
+}
+export = KeyvEtcd;

package/dist/index.js

@@ -0,0 +1,103 @@
+"use strict";
+/* eslint-disable @typescript-eslint/no-unsafe-argument */
+const events_1 = require("events");
+const etcd3_1 = require("etcd3");
+const cockatiel_1 = require("cockatiel");
+class KeyvEtcd extends events_1.EventEmitter {
+    constructor(url, options) {
+        super();
+        this.ttlSupport = typeof (options === null || options === void 0 ? void 0 : options.ttl) === 'number';
+        url = url !== null && url !== void 0 ? url : {};
+        if (typeof url === 'string') {
+            url = { url };
+        }
+        if (url.uri) {
+            url = Object.assign({ url: url.uri }, url);
+        }
+        if (url.ttl) {
+            this.ttlSupport = typeof url.ttl === 'number';
+        }
+        this.opts = Object.assign(Object.assign({ url: '127.0.0.1:2379' }, url), options);
+        this.opts.url = this.opts.url.replace(/^etcd:\/\//, '');
+        const policy = (0, cockatiel_1.retry)(cockatiel_1.handleAll, { backoff: new cockatiel_1.ExponentialBackoff() });
+        policy.onFailure(error => {
+            this.emit('error', error.reason);
+        });
+        this.client = new etcd3_1.Etcd3({
+            hosts: this.opts.url,
+            faultHandling: {
+                // @ts-expect-error - iPolicy
+                host: () => policy,
+                // @ts-expect-error - iPolicy
+                global: policy,
+            },
+        });
+        // Https://github.com/microsoft/etcd3/issues/105
+        this.client.getRoles().catch(error => this.emit('error', error));
+        if (this.ttlSupport) {
+            this.lease = this.client.lease(this.opts.ttl / 1000, {
+                autoKeepAlive: false,
+            });
+        }
+    }
+    get(key) {
+        return this.client.get(key);
+    }
+    getMany(keys) {
+        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) {
+                // @ts-expect-error - value is an object
+                if (value.value === null) {
+                    data.push(undefined);
+                }
+                else {
+                    // @ts-expect-error - value is an object
+                    data.push(value.value);
+                }
+            }
+            return data;
+        });
+    }
+    set(key, value) {
+        let client = 'client';
+        if (this.opts.ttl) {
+            client = 'lease';
+        }
+        // @ts-expect-error - Value needs to be number, string or buffer
+        return this[client].put(key).value(value);
+    }
+    delete(key) {
+        if (typeof key !== 'string') {
+            return Promise.resolve(false);
+        }
+        return this.client.delete().key(key).then(key => key.deleted !== '0');
+    }
+    deleteMany(keys) {
+        const promises = [];
+        for (const key of keys) {
+            promises.push(this.delete(key));
+        }
+        // @ts-expect-error - x is an object
+        return Promise.allSettled(promises).then(values => values.every(x => x.value === true));
+    }
+    clear() {
+        const promise = this.namespace
+            ? this.client.delete().prefix(this.namespace)
+            : this.client.delete().all();
+        return promise.then(() => undefined);
+    }
+    has(key) {
+        return this.client.get(key).exists();
+    }
+    disconnect() {
+        return this.client.close();
+    }
+}
+module.exports = KeyvEtcd;
+//# 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,0DAA0D;AAC1D,mCAAoC;AAEpC,iCAA4B;AAC5B,yCAA+D;AAY/D,MAAM,QAAsB,SAAQ,qBAAY;IAO/C,YAAY,GAA8B,EAAE,OAAyB;QACpE,KAAK,EAAE,CAAC;QAER,IAAI,CAAC,UAAU,GAAG,OAAO,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,GAAG,CAAA,KAAK,QAAQ,CAAC;QAEnD,GAAG,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,EAAE,CAAC;QAEhB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC5B,GAAG,GAAG,EAAC,GAAG,EAAC,CAAC;SACZ;QAED,IAAI,GAAG,CAAC,GAAG,EAAE;YACZ,GAAG,mBAAI,GAAG,EAAE,GAAG,CAAC,GAAG,IAAK,GAAG,CAAC,CAAC;SAC7B;QAED,IAAI,GAAG,CAAC,GAAG,EAAE;YACZ,IAAI,CAAC,UAAU,GAAG,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC;SAC9C;QAED,IAAI,CAAC,IAAI,iCACR,GAAG,EAAE,gBAAgB,IAClB,GAAG,GACH,OAAO,CACV,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAI,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;QAEzD,MAAM,MAAM,GAAG,IAAA,iBAAK,EAAC,qBAAS,EAAE,EAAC,OAAO,EAAE,IAAI,8BAAkB,EAAE,EAAC,CAAC,CAAC;QACrE,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;YACxB,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,MAAM,GAAG,IAAI,aAAK,CAAC;YACvB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;YACpB,aAAa,EAAE;gBACd,6BAA6B;gBAC7B,IAAI,EAAE,GAAG,EAAE,CAAC,MAAM;gBAClB,6BAA6B;gBAC7B,MAAM,EAAE,MAAM;aACd;SACD,CAAC,CAAC;QAEH,gDAAgD;QAChD,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAEjE,IAAI,IAAI,CAAC,UAAU,EAAE;YACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAI,GAAG,IAAI,EAAE;gBACrD,aAAa,EAAE,KAAK;aACpB,CAAC,CAAC;SACH;IACF,CAAC;IAED,GAAG,CAAC,GAAW;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAgC,CAAC;IAC5D,CAAC;IAED,OAAO,CAAC,IAAc;QACrB,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACvB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC;SAC7B;QAED,OAAO,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;aACjC,IAAI,CAAC,MAAM,CAAC,EAAE;YACd,MAAM,IAAI,GAA6B,EAAE,CAAC;YAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE;gBAC3B,wCAAwC;gBACxC,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE;oBACzB,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;iBACrB;qBAAM;oBACN,wCAAwC;oBACxC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;iBACvB;aACD;YAED,OAAO,IAAI,CAAC;QACb,CAAC,CAAC,CAAC;IACL,CAAC;IAED,GAAG,CAAC,GAAW,EAAE,KAAY;QAC5B,IAAI,MAAM,GAAuB,QAAQ,CAAC;QAE1C,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE;YAClB,MAAM,GAAG,OAAO,CAAC;SACjB;QAED,gEAAgE;QAChE,OAAO,IAAI,CAAC,MAAM,CAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IAC5C,CAAC;IAED,MAAM,CAAC,GAAW;QACjB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE;YAC5B,OAAO,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;SAC9B;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,OAAO,KAAK,GAAG,CAAC,CAAC;IACvE,CAAC;IAED,UAAU,CAAC,IAAc;QACxB,MAAM,QAAQ,GAAG,EAAE,CAAC;QACpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;YACvB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;SAChC;QAED,oCAAoC;QACpC,OAAO,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,KAAK,IAAI,CAAC,CAAC,CAAC;IACzF,CAAC;IAED,KAAK;QACJ,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS;YAC7B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;YAC7C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;QAC9B,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAED,GAAG,CAAC,GAAW;QACd,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;IACtC,CAAC;IAED,UAAU;QACT,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;IAC5B,CAAC;CACD;AAED,iBAAS,QAAQ,CAAC"}

package/package.json

@@ -1,10 +1,11 @@
 {
 	"name": "@keyv/etcd",
-	"version": "1.1.5",
+	"version": "1.2.0",
 	"description": "Etcd storage adapter for Keyv",
-	"main": "src/index.js",
+	"main": "dist/index.js",
+	"types": "dist/index.d.ts",
 	"scripts": {
-		"build": "echo 'No build step required.'",
+		"build": "tsc --project tsconfig.dist.json",
 		"prepare": "yarn build",
 		"test": "xo && c8 ava --serial",
 		"test:ci": "xo && ava --serial",
@@ -16,15 +17,10 @@
 			"unicorn/no-array-reduce": 0,
 			"unicorn/prefer-object-from-entries": 0,
 			"unicorn/prefer-node-protocol": 0,
-			"ava/no-ignored-test-files": [
-				"error",
-				{
-					"extensions": [
-						"js",
-						"ts"
-					]
-				}
-			]
+			"import/extensions": 0,
+			"@typescript-eslint/no-confusing-void-expression": 0,
+			"@typescript-eslint/promise-function-async": 0,
+			"eslint-comments/no-unused-disable": 0
 		}
 	},
 	"ava": {
@@ -69,16 +65,15 @@
 		"keyv": "*",
 		"requirable": "^1.0.5",
 		"ts-node": "^10.9.1",
-		"tsd": "^0.28.0",
-		"typescript": "^5.0.2",
-		"webpack": "^5.76.2",
-		"xo": "^0.53.1"
+		"tsd": "^0.28.1",
+		"typescript": "^5.0.4",
+		"webpack": "^5.79.0",
+		"xo": "^0.54.1"
 	},
 	"tsd": {
 		"directory": "test"
 	},
-	"types": "./src/index.d.ts",
 	"files": [
-		"src"
+		"dist"
 	]
 }

package/src/index.d.ts

@@ -1,33 +0,0 @@
-import {EventEmitter} from 'events';
-import type Etcd3 from 'etcd3';
-import type {Store, StoredData} from 'keyv';
-
-declare class KeyvEtcd<Value=any> extends EventEmitter implements Store<Value> {
-	ttlSupport: any;
-	opts: any;
-	client: Etcd3;
-	// eslint-disable-next-line @typescript-eslint/consistent-type-imports
-	lease: import('etcd3').Lease;
-	constructor(options?: string | KeyvEtcd.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>;
-}
-
-declare namespace KeyvEtcd {
-	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
-	interface Options {
-		url?: string | undefined;
-		uri?: string | undefined;
-		ttl?: number | undefined;
-	}
-}
-
-export = KeyvEtcd;

package/src/index.js

@@ -1,115 +0,0 @@
-'use strict';
-
-const EventEmitter = require('events');
-const {Etcd3} = require('etcd3');
-const {handleAll, retry, ExponentialBackoff} = require('cockatiel');
-
-class KeyvEtcd extends EventEmitter {
-	constructor(url, options) {
-		super();
-		this.ttlSupport = options && typeof options.ttl === 'number';
-		url = url || {};
-		if (typeof url === 'string') {
-			url = {url};
-		}
-
-		if (url.uri) {
-			url = {url: url.uri, ...url};
-		}
-
-		if (url.ttl) {
-			this.ttlSupport = typeof url.ttl === 'number';
-		}
-
-		this.opts = {
-			url: '127.0.0.1:2379',
-			...url,
-			...options,
-		};
-
-		this.opts.url = this.opts.url.replace(/^etcd:\/\//, '');
-		const policy = retry(handleAll, {backoff: new ExponentialBackoff()});
-		policy.onFailure(error => {
-			this.emit('error', error.reason);
-		});
-		this.client = new Etcd3(options = {hosts: this.opts.url,
-			faultHandling: {
-				host: () => policy,
-				global: policy,
-			},
-		});
-
-		// Https://github.com/microsoft/etcd3/issues/105
-		this.client.getRoles().catch(error => this.emit('error', error));
-
-		if (this.ttlSupport) {
-			this.lease = this.client.lease(this.opts.ttl / 1000, {
-				autoKeepAlive: false,
-			});
-		}
-	}
-
-	get(key) {
-		return this.client.get(key);
-	}
-
-	getMany(keys) {
-		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) {
-					if (value.value === null) {
-						data.push(undefined);
-					} else {
-						data.push(value.value);
-					}
-				}
-
-				return data;
-			});
-	}
-
-	set(key, value) {
-		return this.opts.ttl ? this.lease.put(key).value(value) : this.client.put(key).value(value);
-	}
-
-	delete(key) {
-		if (typeof key !== 'string') {
-			return Promise.resolve(false);
-		}
-
-		return this.client.delete().key(key).then(key => key.deleted !== '0');
-	}
-
-	deleteMany(keys) {
-		const promises = [];
-		for (const key of keys) {
-			promises.push(this.delete(key));
-		}
-
-		return Promise.allSettled(promises)
-			.then(values => values.every(x => x.value === true));
-	}
-
-	clear() {
-		const promise = this.namespace
-			? this.client.delete().prefix(this.namespace)
-			: this.client.delete().all();
-		return promise.then(() => undefined);
-	}
-
-	has(key) {
-		return this.client.get(key).exists();
-	}
-
-	disconnect() {
-		return this.client.close();
-	}
-}
-
-module.exports = KeyvEtcd;