@keyv/etcd 2.0.0-rc.1 → 2.0.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2017-2021 Luke Childs
+Copyright (c) 2021-2022 Jared Wray
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,4 +1,4 @@
-# @keyv/etcd [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)
+# @keyv/etcd [<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)
 
 > Etcd storage adapter for Keyv
 
@@ -17,12 +17,13 @@ npm install --save keyv @keyv/etcd
 ## Usage
 
 ```js
-const Keyv = require('keyv');
+import Keyv from 'keyv';
+import KeyvEtcd from '@keyv/etcd';
 
-const keyv = new Keyv('etcd://localhost:2379');
+const keyv = new Keyv(new KeyvEtcd('etcd://localhost:2379'));
 keyv.on('error', handleConnectionError);
 ```
 
 ## License
 
-Copyright (c) 2022 Jared Wray
+[MIT © Jared Wray](LICENSE)

package/dist/cjs/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import { Etcd3, type Lease } from 'etcd3';
 import type { StoredData } from 'keyv';

package/dist/esm/index.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { EventEmitter } from 'events';
 import { Etcd3, type Lease } from 'etcd3';
 import type { StoredData } from 'keyv';

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@keyv/etcd",
-	"version": "2.0.0-rc.1",
+	"version": "2.0.0",
 	"description": "Etcd storage adapter for Keyv",
 	"main": "dist/cjs/index.js",
 	"module": "dist/esm/index.js",
@@ -12,7 +12,7 @@
 		}
 	},
 	"scripts": {
-		"build": "tsc --project tsconfig.csj.json && tsc --project tsconfig.esm.json",
+		"build": "rm -rf dist && tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json",
 		"prepare": "yarn build",
 		"test": "xo --fix && vitest run --coverage",
 		"test:ci": "xo && vitest --run --sequence.setupFiles=list",
@@ -24,6 +24,8 @@
 			"unicorn/no-array-reduce": "off",
 			"unicorn/prefer-object-from-entries": "off",
 			"unicorn/prefer-node-protocol": "off",
+			"n/file-extension-in-import": "off",
+			"@typescript-eslint/use-unknown-in-catch-callback-variable": "off",
 			"import/extensions": "off",
 			"@typescript-eslint/no-confusing-void-expression": "off",
 			"@typescript-eslint/promise-function-async": "off",
@@ -68,19 +70,20 @@
 	},
 	"devDependencies": {
 		"@keyv/test-suite": "*",
-		"c8": "^9.1.0",
-		"keyv": "^5.0.0-rc.1",
+		"c8": "^10.1.2",
+		"keyv": "^5.0.0",
 		"requirable": "^1.0.5",
 		"ts-node": "^10.9.2",
-		"tsd": "^0.31.0",
-		"typescript": "^5.4.5",
-		"webpack": "^5.91.0",
-		"xo": "^0.58.0"
+		"tsd": "^0.31.1",
+		"typescript": "^5.5.4",
+		"webpack": "^5.93.0",
+		"xo": "^0.59.3"
 	},
 	"tsd": {
 		"directory": "test"
 	},
 	"files": [
-		"dist"
+		"dist",
+		"LICENSE"
 	]
 }

package/dist/index.d.ts

@@ -1,29 +0,0 @@
-/// <reference types="node" />
-import { EventEmitter } from 'events';
-import { Etcd3, type Lease } from 'etcd3';
-import type { StoredData } from 'keyv';
-import type { ClearOutput, DeleteManyOutput, DeleteOutput, GetOutput, HasOutput, SetOutput } from './types';
-type KeyvEtcdOptions = {
-    url?: string;
-    uri?: string;
-    ttl?: number;
-    busyTimeout?: number;
-};
-declare class KeyvEtcd<Value = any> extends EventEmitter {
-    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): SetOutput;
-    delete(key: string): DeleteOutput;
-    deleteMany(keys: string[]): DeleteManyOutput;
-    clear(): ClearOutput;
-    iterator(namespace?: string): AsyncGenerator<(string | Awaited<Value> | undefined)[], void, unknown>;
-    has(key: string): HasOutput;
-    disconnect(): Promise<void>;
-}
-export = KeyvEtcd;

package/dist/index.js

@@ -1,161 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
-var __asyncValues = (this && this.__asyncValues) || function (o) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var m = o[Symbol.asyncIterator], i;
-    return m ? m.call(o) : (o = typeof __values === "function" ? __values(o) : o[Symbol.iterator](), i = {}, verb("next"), verb("throw"), verb("return"), i[Symbol.asyncIterator] = function () { return this; }, i);
-    function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }
-    function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
-};
-var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
-    if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
-    var g = generator.apply(thisArg, _arguments || []), i, q = [];
-    return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
-    function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
-    function verb(n, f) { if (g[n]) { i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; if (f) i[n] = f(i[n]); } }
-    function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
-    function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
-    function fulfill(value) { resume("next", value); }
-    function reject(value) { resume("throw", value); }
-    function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
-};
-const events_1 = require("events");
-const etcd3_1 = require("etcd3");
-class KeyvEtcd extends events_1.EventEmitter {
-    constructor(url, options) {
-        super();
-        this.ttlSupport = typeof (options === null || options === void 0 ? void 0 : options.ttl) === 'number';
-        url !== null && url !== void 0 ? url : (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:\/\//, '');
-        this.client = new etcd3_1.Etcd3({
-            hosts: this.opts.url,
-        });
-        // 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 __awaiter(this, void 0, void 0, function* () {
-            return this.client.get(key);
-        });
-    }
-    getMany(keys) {
-        return __awaiter(this, void 0, void 0, function* () {
-            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) {
-        return __awaiter(this, void 0, void 0, function* () {
-            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) {
-        return __awaiter(this, void 0, void 0, function* () {
-            if (typeof key !== 'string') {
-                return false;
-            }
-            return this.client.delete().key(key).then(key => key.deleted !== '0');
-        });
-    }
-    deleteMany(keys) {
-        return __awaiter(this, void 0, void 0, function* () {
-            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() {
-        return __awaiter(this, void 0, void 0, function* () {
-            const promise = this.namespace
-                ? this.client.delete().prefix(this.namespace)
-                : this.client.delete().all();
-            return promise.then(() => undefined);
-        });
-    }
-    iterator(namespace) {
-        return __asyncGenerator(this, arguments, function* iterator_1() {
-            var _a, e_1, _b, _c;
-            const iterator = yield __await(this.client
-                .getAll()
-                .prefix(namespace ? namespace + ':' : '')
-                .keys());
-            try {
-                for (var _d = true, iterator_2 = __asyncValues(iterator), iterator_2_1; iterator_2_1 = yield __await(iterator_2.next()), _a = iterator_2_1.done, !_a; _d = true) {
-                    _c = iterator_2_1.value;
-                    _d = false;
-                    const key = _c;
-                    const value = yield __await(this.get(key));
-                    yield yield __await([key, value]);
-                }
-            }
-            catch (e_1_1) { e_1 = { error: e_1_1 }; }
-            finally {
-                try {
-                    if (!_d && !_a && (_b = iterator_2.return)) yield __await(_b.call(iterator_2));
-                }
-                finally { if (e_1) throw e_1.error; }
-            }
-        });
-    }
-    has(key) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.client.get(key).exists();
-        });
-    }
-    disconnect() {
-        return __awaiter(this, void 0, void 0, function* () {
-            return this.client.close();
-        });
-    }
-}
-module.exports = KeyvEtcd;
-//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAAoC;AACpC,iCAAwC;AAaxC,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,aAAH,GAAG,cAAH,GAAG,IAAH,GAAG,GAAK,EAAE,EAAC;QAEX,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,mBAAI,GAAG,EAAE,GAAG,CAAC,GAAG,IAAK,GAAG,CAAC,CAAC;QAC9B,CAAC;QAED,IAAI,GAAG,CAAC,GAAG,EAAE,CAAC;YACb,IAAI,CAAC,UAAU,GAAG,OAAO,GAAG,CAAC,GAAG,KAAK,QAAQ,CAAC;QAC/C,CAAC;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,IAAI,CAAC,MAAM,GAAG,IAAI,aAAK,CAAC;YACvB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,GAAG;SACpB,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,CAAC;YACrB,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;QACJ,CAAC;IACF,CAAC;IAEK,GAAG,CAAC,GAAW;;YACpB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAgC,CAAC;QAC5D,CAAC;KAAA;IAEK,OAAO,CAAC,IAAc;;YAC3B,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,OAAO,OAAO,CAAC,UAAU,CAAC,QAAQ,CAAC;iBACjC,IAAI,CAAC,MAAM,CAAC,EAAE;gBACd,MAAM,IAAI,GAA6B,EAAE,CAAC;gBAC1C,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;oBAC5B,wCAAwC;oBACxC,IAAI,KAAK,CAAC,KAAK,KAAK,IAAI,EAAE,CAAC;wBAC1B,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;oBACtB,CAAC;yBAAM,CAAC;wBACP,wCAAwC;wBACxC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,KAA0B,CAAC,CAAC;oBAC7C,CAAC;gBACF,CAAC;gBAED,OAAO,IAAI,CAAC;YACb,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,GAAG,CAAC,GAAW,EAAE,KAAY;;YAClC,IAAI,MAAM,GAAuB,QAAQ,CAAC;YAE1C,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC;gBACnB,MAAM,GAAG,OAAO,CAAC;YAClB,CAAC;YAED,gEAAgE;YAChE,OAAO,IAAI,CAAC,MAAM,CAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QAC5C,CAAC;KAAA;IAEK,MAAM,CAAC,GAAW;;YACvB,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;gBAC7B,OAAO,KAAK,CAAC;YACd,CAAC;YAED,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;QACvE,CAAC;KAAA;IAEK,UAAU,CAAC,IAAc;;YAC9B,MAAM,QAAQ,GAAG,EAAE,CAAC;YACpB,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YACjC,CAAC;YAED,oCAAoC;YACpC,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;QACzF,CAAC;KAAA;IAEK,KAAK;;YACV,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS;gBAC7B,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;gBAC7C,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,GAAG,EAAE,CAAC;YAC9B,OAAO,OAAO,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,SAAS,CAAC,CAAC;QACtC,CAAC;KAAA;IAEO,QAAQ,CAAC,SAAkB;;;YAClC,MAAM,QAAQ,GAAG,cAAM,IAAI,CAAC,MAAM;iBAChC,MAAM,EAAE;iBACR,MAAM,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;iBACxC,IAAI,EAAE,CAAA,CAAC;;gBAET,KAAwB,eAAA,aAAA,cAAA,QAAQ,CAAA,cAAA,2FAAE,CAAC;oBAAX,wBAAQ;oBAAR,WAAQ;oBAArB,MAAM,GAAG,KAAA,CAAA;oBACnB,MAAM,KAAK,GAAG,cAAM,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA,CAAC;oBAClC,oBAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA,CAAC;gBACpB,CAAC;;;;;;;;;QACF,CAAC;KAAA;IAEK,GAAG,CAAC,GAAW;;YACpB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC;QACtC,CAAC;KAAA;IAEK,UAAU;;YACf,OAAO,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;QAC5B,CAAC;KAAA;CACD;AAED,iBAAS,QAAQ,CAAC"}

package/dist/types.d.ts

@@ -1,8 +0,0 @@
-import { type StoredData } from 'keyv';
-export type GetOutput<Value> = Promise<Value | undefined>;
-export type GetManyOutput<Value> = Promise<Array<StoredData<Value | undefined> | undefined>>;
-export type SetOutput = Promise<any>;
-export type DeleteOutput = Promise<boolean>;
-export type DeleteManyOutput = Promise<boolean>;
-export type ClearOutput = Promise<void>;
-export type HasOutput = Promise<boolean>;

package/dist/types.js

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

package/dist/types.js.map

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