@keyv/sqlite 3.6.7 → 4.0.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.
package/LICENSE ADDED
@@ -0,0 +1,22 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2017-2021 Luke Childs
4
+ Copyright (c) 2021-2022 Jared Wray
5
+
6
+ Permission is hereby granted, free of charge, to any person obtaining a copy
7
+ of this software and associated documentation files (the "Software"), to deal
8
+ in the Software without restriction, including without limitation the rights
9
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
10
+ copies of the Software, and to permit persons to whom the Software is
11
+ furnished to do so, subject to the following conditions:
12
+
13
+ The above copyright notice and this permission notice shall be included in all
14
+ copies or substantial portions of the Software.
15
+
16
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22
+ SOFTWARE.
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @keyv/sqlite [<img width="100" align="right" src="https://jaredwray.com/images/keyv.svg" alt="keyv">](https://github.com/jaredwra/keyv)
1
+ # @keyv/sqlite [<img width="100" align="right" src="https://jaredwray.com/images/keyv-symbol.svg" alt="keyv">](https://github.com/jaredwra/keyv)
2
2
 
3
3
  > SQLite storage adapter for Keyv
4
4
 
@@ -18,9 +18,10 @@ npm install --save keyv @keyv/sqlite
18
18
  ## Usage
19
19
 
20
20
  ```js
21
- const Keyv = require('keyv');
21
+ import Keyv from 'keyv';
22
+ import KeyvSqlite from '@keyv/sqlite';
22
23
 
23
- const keyv = new Keyv('sqlite://path/to/database.sqlite');
24
+ const keyv = new Keyv(new KeyvSqlite('sqlite://path/to/database.sqlite'));
24
25
  keyv.on('error', handleConnectionError);
25
26
  ```
26
27
 
@@ -29,12 +30,18 @@ You can specify the `table` and [`busyTimeout`](https://sqlite.org/c3ref/busy_ti
29
30
  e.g:
30
31
 
31
32
  ```js
32
- const keyv = new Keyv('sqlite://path/to/database.sqlite', {
33
+ import Keyv from 'keyv';
34
+ import KeyvSqlite from '@keyv/sqlite';
35
+
36
+ const keyvSqlite = new KeyvSqlite('sqlite://path/to/database.sqlite', {
33
37
  table: 'cache',
34
38
  busyTimeout: 10000
35
39
  });
40
+
41
+ const keyv = new Keyv({ store: keyvSqlite });
36
42
  ```
37
43
 
38
44
  ## License
39
45
 
40
- MIT © Jared Wray
46
+ [MIT © Jared Wray](LISCENCE)
47
+
package/dist/index.cjs ADDED
@@ -0,0 +1,164 @@
1
+ "use strict";
2
+ var __create = Object.create;
3
+ var __defProp = Object.defineProperty;
4
+ var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
5
+ var __getOwnPropNames = Object.getOwnPropertyNames;
6
+ var __getProtoOf = Object.getPrototypeOf;
7
+ var __hasOwnProp = Object.prototype.hasOwnProperty;
8
+ var __export = (target, all) => {
9
+ for (var name in all)
10
+ __defProp(target, name, { get: all[name], enumerable: true });
11
+ };
12
+ var __copyProps = (to, from, except, desc) => {
13
+ if (from && typeof from === "object" || typeof from === "function") {
14
+ for (let key of __getOwnPropNames(from))
15
+ if (!__hasOwnProp.call(to, key) && key !== except)
16
+ __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
17
+ }
18
+ return to;
19
+ };
20
+ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
21
+ // If the importer is in node compatibility mode or this is not an ESM
22
+ // file that has been converted to a CommonJS file using a Babel-
23
+ // compatible transform (i.e. "__esModule" has not been set), then set
24
+ // "default" to the CommonJS "module.exports" for node compatibility.
25
+ isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
26
+ mod
27
+ ));
28
+ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
29
+
30
+ // src/index.ts
31
+ var src_exports = {};
32
+ __export(src_exports, {
33
+ KeyvSqlite: () => KeyvSqlite,
34
+ default: () => src_default
35
+ });
36
+ module.exports = __toCommonJS(src_exports);
37
+ var import_events = __toESM(require("events"), 1);
38
+ var import_util = require("util");
39
+ var import_sqlite3 = __toESM(require("sqlite3"), 1);
40
+ var toString = (input) => String(input).search(/^[a-zA-Z]+$/) < 0 ? "_" + input : input;
41
+ var KeyvSqlite = class extends import_events.default {
42
+ ttlSupport;
43
+ opts;
44
+ namespace;
45
+ close;
46
+ query;
47
+ constructor(keyvOptions) {
48
+ super();
49
+ this.ttlSupport = false;
50
+ let options = {
51
+ dialect: "sqlite",
52
+ uri: "sqlite://:memory:"
53
+ };
54
+ if (typeof keyvOptions === "string") {
55
+ options.uri = keyvOptions;
56
+ } else {
57
+ options = {
58
+ ...options,
59
+ ...keyvOptions
60
+ };
61
+ }
62
+ options.db = options.uri.replace(/^sqlite:\/\//, "");
63
+ options.connect = async () => new Promise((resolve, reject) => {
64
+ const database = new import_sqlite3.default.Database(options.db, (error) => {
65
+ if (error) {
66
+ reject(error);
67
+ } else {
68
+ if (options.busyTimeout) {
69
+ database.configure("busyTimeout", options.busyTimeout);
70
+ }
71
+ resolve(database);
72
+ }
73
+ });
74
+ }).then((database) => ({ query: (0, import_util.promisify)(database.all).bind(database), close: (0, import_util.promisify)(database.close).bind(database) }));
75
+ this.opts = {
76
+ table: "keyv",
77
+ keySize: 255,
78
+ ...options
79
+ };
80
+ this.opts.table = toString(this.opts.table);
81
+ const createTable = `CREATE TABLE IF NOT EXISTS ${this.opts.table}(key VARCHAR(${Number(this.opts.keySize)}) PRIMARY KEY, value TEXT )`;
82
+ const connected = this.opts.connect().then(async (database) => database.query(createTable).then(() => database)).catch((error) => this.emit("error", error));
83
+ this.query = async (sqlString, ...parameter) => connected.then(async (database) => database.query(sqlString, ...parameter));
84
+ this.close = async () => connected.then((database) => database.close);
85
+ }
86
+ async get(key) {
87
+ const select = `SELECT * FROM ${this.opts.table} WHERE key = ?`;
88
+ const rows = await this.query(select, key);
89
+ const row = rows[0];
90
+ if (row === void 0) {
91
+ return void 0;
92
+ }
93
+ return row.value;
94
+ }
95
+ async getMany(keys) {
96
+ const select = `SELECT * FROM ${this.opts.table} WHERE key IN (SELECT value FROM json_each(?))`;
97
+ const rows = await this.query(select, JSON.stringify(keys));
98
+ return keys.map((key) => {
99
+ const row = rows.find((row2) => row2.key === key);
100
+ return row ? row.value : void 0;
101
+ });
102
+ }
103
+ async set(key, value) {
104
+ const upsert = `INSERT INTO ${this.opts.table} (key, value)
105
+ VALUES(?, ?)
106
+ ON CONFLICT(key)
107
+ DO UPDATE SET value=excluded.value;`;
108
+ return this.query(upsert, key, value);
109
+ }
110
+ async delete(key) {
111
+ const select = `SELECT * FROM ${this.opts.table} WHERE key = ?`;
112
+ const del = `DELETE FROM ${this.opts.table} WHERE key = ?`;
113
+ const rows = await this.query(select, key);
114
+ const row = rows[0];
115
+ if (row === void 0) {
116
+ return false;
117
+ }
118
+ await this.query(del, key);
119
+ return true;
120
+ }
121
+ async deleteMany(keys) {
122
+ const del = `DELETE FROM ${this.opts.table} WHERE key IN (SELECT value FROM json_each(?))`;
123
+ const results = await this.getMany(keys);
124
+ if (results.every((x) => x === void 0)) {
125
+ return false;
126
+ }
127
+ await this.query(del, JSON.stringify(keys));
128
+ return true;
129
+ }
130
+ async clear() {
131
+ const del = `DELETE FROM ${this.opts.table} WHERE key LIKE ?`;
132
+ await this.query(del, this.namespace ? `${this.namespace}:%` : "%");
133
+ }
134
+ async *iterator(namespace) {
135
+ const limit = Number.parseInt(this.opts.iterationLimit, 10) || 10;
136
+ async function* iterate(offset, options, query) {
137
+ const select = `SELECT * FROM ${options.table} WHERE key LIKE ? LIMIT ? OFFSET ?`;
138
+ const iterator = await query(select, [`${namespace ? namespace + ":" : ""}%`, limit, offset]);
139
+ const entries = [...iterator];
140
+ if (entries.length === 0) {
141
+ return;
142
+ }
143
+ for (const entry of entries) {
144
+ offset += 1;
145
+ yield [entry.key, entry.value];
146
+ }
147
+ yield* iterate(offset, options, query);
148
+ }
149
+ yield* iterate(0, this.opts, this.query);
150
+ }
151
+ async has(key) {
152
+ const exists = `SELECT EXISTS ( SELECT * FROM ${this.opts.table} WHERE key = ? )`;
153
+ const result = await this.query(exists, key);
154
+ return Object.values(result[0])[0] === 1;
155
+ }
156
+ async disconnect() {
157
+ await this.close();
158
+ }
159
+ };
160
+ var src_default = KeyvSqlite;
161
+ // Annotate the CommonJS export names for ESM import in node:
162
+ 0 && (module.exports = {
163
+ KeyvSqlite
164
+ });
@@ -0,0 +1,38 @@
1
+ import EventEmitter from 'events';
2
+ import { KeyvStoreAdapter, StoredData } from 'keyv';
3
+
4
+ type DbQuery = (sqlString: string, ...parameter: unknown[]) => Promise<any>;
5
+ type DbClose = () => Promise<void>;
6
+ type KeyvSqliteOptions = {
7
+ dialect?: string;
8
+ uri?: string;
9
+ busyTimeout?: number;
10
+ table?: string;
11
+ keySize?: number;
12
+ db?: string;
13
+ iterationLimit?: number | string;
14
+ connect?: () => Promise<{
15
+ query: DbQuery;
16
+ close: DbClose;
17
+ }>;
18
+ };
19
+
20
+ declare class KeyvSqlite extends EventEmitter implements KeyvStoreAdapter {
21
+ ttlSupport: boolean;
22
+ opts: KeyvSqliteOptions;
23
+ namespace?: string;
24
+ close: DbClose;
25
+ query: DbQuery;
26
+ constructor(keyvOptions?: KeyvSqliteOptions | string);
27
+ get<Value>(key: string): Promise<Value | undefined>;
28
+ getMany<Value>(keys: string[]): Promise<StoredData<Value | undefined>[]>;
29
+ set(key: string, value: any): Promise<any>;
30
+ delete(key: string): Promise<boolean>;
31
+ deleteMany(keys: string[]): Promise<boolean>;
32
+ clear(): Promise<void>;
33
+ iterator(namespace?: string): AsyncGenerator<any, void, any>;
34
+ has(key: string): Promise<boolean>;
35
+ disconnect(): Promise<void>;
36
+ }
37
+
38
+ export { KeyvSqlite, KeyvSqlite as default };
package/dist/index.d.ts CHANGED
@@ -1,21 +1,38 @@
1
- /// <reference types="node" />
2
1
  import EventEmitter from 'events';
3
- import { type ClearOutput, type DbClose, type DbQuery, type DeleteManyOutput, type DeleteOutput, type DisconnectOutput, type GetManyOutput, type GetOutput, type HasOutput, type IteratorOutput, type KeyvSqliteOptions, type SetOutput } from './types';
4
- declare class KeyvSqlite<Value = any> extends EventEmitter {
2
+ import { KeyvStoreAdapter, StoredData } from 'keyv';
3
+
4
+ type DbQuery = (sqlString: string, ...parameter: unknown[]) => Promise<any>;
5
+ type DbClose = () => Promise<void>;
6
+ type KeyvSqliteOptions = {
7
+ dialect?: string;
8
+ uri?: string;
9
+ busyTimeout?: number;
10
+ table?: string;
11
+ keySize?: number;
12
+ db?: string;
13
+ iterationLimit?: number | string;
14
+ connect?: () => Promise<{
15
+ query: DbQuery;
16
+ close: DbClose;
17
+ }>;
18
+ };
19
+
20
+ declare class KeyvSqlite extends EventEmitter implements KeyvStoreAdapter {
5
21
  ttlSupport: boolean;
6
22
  opts: KeyvSqliteOptions;
7
23
  namespace?: string;
8
24
  close: DbClose;
9
25
  query: DbQuery;
10
26
  constructor(keyvOptions?: KeyvSqliteOptions | string);
11
- get(key: string): GetOutput<Value>;
12
- getMany(keys: string[]): GetManyOutput<Value>;
13
- set(key: string, value: Value): SetOutput;
14
- delete(key: string): DeleteOutput;
15
- deleteMany(keys: string[]): DeleteManyOutput;
16
- clear(): ClearOutput;
17
- iterator(namespace?: string): IteratorOutput;
18
- has(key: string): HasOutput;
19
- disconnect(): DisconnectOutput;
27
+ get<Value>(key: string): Promise<Value | undefined>;
28
+ getMany<Value>(keys: string[]): Promise<StoredData<Value | undefined>[]>;
29
+ set(key: string, value: any): Promise<any>;
30
+ delete(key: string): Promise<boolean>;
31
+ deleteMany(keys: string[]): Promise<boolean>;
32
+ clear(): Promise<void>;
33
+ iterator(namespace?: string): AsyncGenerator<any, void, any>;
34
+ has(key: string): Promise<boolean>;
35
+ disconnect(): Promise<void>;
20
36
  }
21
- export = KeyvSqlite;
37
+
38
+ export { KeyvSqlite, KeyvSqlite as default };
package/dist/index.js CHANGED
@@ -1,188 +1,129 @@
1
- "use strict";
2
- var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
- function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
- return new (P || (P = Promise))(function (resolve, reject) {
5
- function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
- function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
- function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
- step((generator = generator.apply(thisArg, _arguments || [])).next());
9
- });
10
- };
11
- var __await = (this && this.__await) || function (v) { return this instanceof __await ? (this.v = v, this) : new __await(v); }
12
- var __asyncValues = (this && this.__asyncValues) || function (o) {
13
- if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
14
- var m = o[Symbol.asyncIterator], i;
15
- 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);
16
- 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); }); }; }
17
- function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }
18
- };
19
- var __asyncDelegator = (this && this.__asyncDelegator) || function (o) {
20
- var i, p;
21
- return i = {}, verb("next"), verb("throw", function (e) { throw e; }), verb("return"), i[Symbol.iterator] = function () { return this; }, i;
22
- function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: false } : f ? f(v) : v; } : f; }
23
- };
24
- var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _arguments, generator) {
25
- if (!Symbol.asyncIterator) throw new TypeError("Symbol.asyncIterator is not defined.");
26
- var g = generator.apply(thisArg, _arguments || []), i, q = [];
27
- return i = {}, verb("next"), verb("throw"), verb("return", awaitReturn), i[Symbol.asyncIterator] = function () { return this; }, i;
28
- function awaitReturn(f) { return function (v) { return Promise.resolve(v).then(f, reject); }; }
29
- 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]); } }
30
- function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }
31
- function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }
32
- function fulfill(value) { resume("next", value); }
33
- function reject(value) { resume("throw", value); }
34
- function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }
35
- };
36
- var __importDefault = (this && this.__importDefault) || function (mod) {
37
- return (mod && mod.__esModule) ? mod : { "default": mod };
38
- };
39
- const events_1 = __importDefault(require("events"));
40
- const util_1 = require("util");
41
- const sqlite3_1 = __importDefault(require("sqlite3"));
42
- const toString = (input) => String(input).search(/^[a-zA-Z]+$/) < 0 ? '_' + input : input;
43
- class KeyvSqlite extends events_1.default {
44
- constructor(keyvOptions) {
45
- super();
46
- this.ttlSupport = false;
47
- let options = {
48
- dialect: 'sqlite',
49
- uri: 'sqlite://:memory:',
50
- };
51
- if (typeof keyvOptions === 'string') {
52
- options.uri = keyvOptions;
53
- }
54
- else {
55
- options = Object.assign(Object.assign({}, options), keyvOptions);
56
- }
57
- options.db = options.uri.replace(/^sqlite:\/\//, '');
58
- options.connect = () => __awaiter(this, void 0, void 0, function* () {
59
- return new Promise((resolve, reject) => {
60
- const db = new sqlite3_1.default.Database(options.db, error => {
61
- if (error) {
62
- reject(error);
63
- }
64
- else {
65
- if (options.busyTimeout) {
66
- db.configure('busyTimeout', options.busyTimeout);
67
- }
68
- resolve(db);
69
- }
70
- });
71
- })
72
- // @ts-expect-error - db is unknown
73
- .then(db => ({ query: (0, util_1.promisify)(db.all).bind(db), close: (0, util_1.promisify)(db.close).bind(db) }));
74
- });
75
- this.opts = Object.assign({ table: 'keyv', keySize: 255 }, options);
76
- this.opts.table = toString(this.opts.table);
77
- const createTable = `CREATE TABLE IF NOT EXISTS ${this.opts.table}(key VARCHAR(${Number(this.opts.keySize)}) PRIMARY KEY, value TEXT )`;
78
- // @ts-expect-error - db is
79
- const connected = this.opts.connect()
80
- .then((db) => __awaiter(this, void 0, void 0, function* () { return db.query(createTable).then(() => db); }))
81
- .catch(error => this.emit('error', error));
82
- this.query = (sqlString, ...parameter) => __awaiter(this, void 0, void 0, function* () {
83
- return connected
84
- .then((db) => __awaiter(this, void 0, void 0, function* () { return db.query(sqlString, ...parameter); }));
85
- });
86
- this.close = () => __awaiter(this, void 0, void 0, function* () { return connected.then(db => db.close); });
87
- }
88
- get(key) {
89
- return __awaiter(this, void 0, void 0, function* () {
90
- const select = `SELECT * FROM ${this.opts.table} WHERE key = ?`;
91
- const rows = yield this.query(select, key);
92
- const row = rows[0];
93
- if (row === undefined) {
94
- return undefined;
95
- }
96
- return row.value;
97
- });
1
+ // src/index.ts
2
+ import EventEmitter from "events";
3
+ import { promisify } from "util";
4
+ import sqlite3 from "sqlite3";
5
+ var toString = (input) => String(input).search(/^[a-zA-Z]+$/) < 0 ? "_" + input : input;
6
+ var KeyvSqlite = class extends EventEmitter {
7
+ ttlSupport;
8
+ opts;
9
+ namespace;
10
+ close;
11
+ query;
12
+ constructor(keyvOptions) {
13
+ super();
14
+ this.ttlSupport = false;
15
+ let options = {
16
+ dialect: "sqlite",
17
+ uri: "sqlite://:memory:"
18
+ };
19
+ if (typeof keyvOptions === "string") {
20
+ options.uri = keyvOptions;
21
+ } else {
22
+ options = {
23
+ ...options,
24
+ ...keyvOptions
25
+ };
98
26
  }
99
- getMany(keys) {
100
- return __awaiter(this, void 0, void 0, function* () {
101
- const select = `SELECT * FROM ${this.opts.table} WHERE key IN (SELECT value FROM json_each(?))`;
102
- const rows = yield this.query(select, JSON.stringify(keys));
103
- const results = [...keys];
104
- let i = 0;
105
- for (const key of keys) {
106
- const rowIndex = rows.findIndex((row) => row.key === key);
107
- results[i] = rowIndex > -1 ? rows[rowIndex].value : undefined;
108
- i++;
109
- }
110
- return results;
111
- });
27
+ options.db = options.uri.replace(/^sqlite:\/\//, "");
28
+ options.connect = async () => new Promise((resolve, reject) => {
29
+ const database = new sqlite3.Database(options.db, (error) => {
30
+ if (error) {
31
+ reject(error);
32
+ } else {
33
+ if (options.busyTimeout) {
34
+ database.configure("busyTimeout", options.busyTimeout);
35
+ }
36
+ resolve(database);
37
+ }
38
+ });
39
+ }).then((database) => ({ query: promisify(database.all).bind(database), close: promisify(database.close).bind(database) }));
40
+ this.opts = {
41
+ table: "keyv",
42
+ keySize: 255,
43
+ ...options
44
+ };
45
+ this.opts.table = toString(this.opts.table);
46
+ const createTable = `CREATE TABLE IF NOT EXISTS ${this.opts.table}(key VARCHAR(${Number(this.opts.keySize)}) PRIMARY KEY, value TEXT )`;
47
+ const connected = this.opts.connect().then(async (database) => database.query(createTable).then(() => database)).catch((error) => this.emit("error", error));
48
+ this.query = async (sqlString, ...parameter) => connected.then(async (database) => database.query(sqlString, ...parameter));
49
+ this.close = async () => connected.then((database) => database.close);
50
+ }
51
+ async get(key) {
52
+ const select = `SELECT * FROM ${this.opts.table} WHERE key = ?`;
53
+ const rows = await this.query(select, key);
54
+ const row = rows[0];
55
+ if (row === void 0) {
56
+ return void 0;
112
57
  }
113
- set(key, value) {
114
- return __awaiter(this, void 0, void 0, function* () {
115
- const upsert = `INSERT INTO ${this.opts.table} (key, value)
58
+ return row.value;
59
+ }
60
+ async getMany(keys) {
61
+ const select = `SELECT * FROM ${this.opts.table} WHERE key IN (SELECT value FROM json_each(?))`;
62
+ const rows = await this.query(select, JSON.stringify(keys));
63
+ return keys.map((key) => {
64
+ const row = rows.find((row2) => row2.key === key);
65
+ return row ? row.value : void 0;
66
+ });
67
+ }
68
+ async set(key, value) {
69
+ const upsert = `INSERT INTO ${this.opts.table} (key, value)
116
70
  VALUES(?, ?)
117
71
  ON CONFLICT(key)
118
72
  DO UPDATE SET value=excluded.value;`;
119
- return this.query(upsert, key, value);
120
- });
121
- }
122
- delete(key) {
123
- return __awaiter(this, void 0, void 0, function* () {
124
- const select = `SELECT * FROM ${this.opts.table} WHERE key = ?`;
125
- const del = `DELETE FROM ${this.opts.table} WHERE key = ?`;
126
- const rows = yield this.query(select, key);
127
- const row = rows[0];
128
- if (row === undefined) {
129
- return false;
130
- }
131
- yield this.query(del, key);
132
- return true;
133
- });
134
- }
135
- deleteMany(keys) {
136
- return __awaiter(this, void 0, void 0, function* () {
137
- const del = `DELETE FROM ${this.opts.table} WHERE key IN (SELECT value FROM json_each(?))`;
138
- const results = yield this.getMany(keys);
139
- if (results.every(x => x === undefined)) {
140
- return false;
141
- }
142
- yield this.query(del, JSON.stringify(keys));
143
- return true;
144
- });
73
+ return this.query(upsert, key, value);
74
+ }
75
+ async delete(key) {
76
+ const select = `SELECT * FROM ${this.opts.table} WHERE key = ?`;
77
+ const del = `DELETE FROM ${this.opts.table} WHERE key = ?`;
78
+ const rows = await this.query(select, key);
79
+ const row = rows[0];
80
+ if (row === void 0) {
81
+ return false;
145
82
  }
146
- clear() {
147
- return __awaiter(this, void 0, void 0, function* () {
148
- const del = `DELETE FROM ${this.opts.table} WHERE key LIKE ?`;
149
- yield this.query(del, this.namespace ? `${this.namespace}:%` : '%');
150
- });
83
+ await this.query(del, key);
84
+ return true;
85
+ }
86
+ async deleteMany(keys) {
87
+ const del = `DELETE FROM ${this.opts.table} WHERE key IN (SELECT value FROM json_each(?))`;
88
+ const results = await this.getMany(keys);
89
+ if (results.every((x) => x === void 0)) {
90
+ return false;
151
91
  }
152
- iterator(namespace) {
153
- return __asyncGenerator(this, arguments, function* iterator_1() {
154
- const limit = Number.parseInt(this.opts.iterationLimit, 10) || 10;
155
- // @ts-expect-error - iterate
156
- function iterate(offset, options, query) {
157
- return __asyncGenerator(this, arguments, function* iterate_1() {
158
- const select = `SELECT * FROM ${options.table} WHERE key LIKE ? LIMIT ? OFFSET ?`;
159
- const iterator = yield __await(query(select, [`${namespace ? namespace + ':' : ''}%`, limit, offset]));
160
- const entries = [...iterator];
161
- if (entries.length === 0) {
162
- return yield __await(void 0);
163
- }
164
- for (const entry of entries) {
165
- offset += 1;
166
- yield yield __await([entry.key, entry.value]);
167
- }
168
- yield __await(yield* __asyncDelegator(__asyncValues(iterate(offset, options, query))));
169
- });
170
- }
171
- yield __await(yield* __asyncDelegator(__asyncValues(iterate(0, this.opts, this.query))));
172
- });
92
+ await this.query(del, JSON.stringify(keys));
93
+ return true;
94
+ }
95
+ async clear() {
96
+ const del = `DELETE FROM ${this.opts.table} WHERE key LIKE ?`;
97
+ await this.query(del, this.namespace ? `${this.namespace}:%` : "%");
98
+ }
99
+ async *iterator(namespace) {
100
+ const limit = Number.parseInt(this.opts.iterationLimit, 10) || 10;
101
+ async function* iterate(offset, options, query) {
102
+ const select = `SELECT * FROM ${options.table} WHERE key LIKE ? LIMIT ? OFFSET ?`;
103
+ const iterator = await query(select, [`${namespace ? namespace + ":" : ""}%`, limit, offset]);
104
+ const entries = [...iterator];
105
+ if (entries.length === 0) {
106
+ return;
107
+ }
108
+ for (const entry of entries) {
109
+ offset += 1;
110
+ yield [entry.key, entry.value];
111
+ }
112
+ yield* iterate(offset, options, query);
173
113
  }
174
- has(key) {
175
- return __awaiter(this, void 0, void 0, function* () {
176
- const exists = `SELECT EXISTS ( SELECT * FROM ${this.opts.table} WHERE key = ? )`;
177
- const result = yield this.query(exists, key);
178
- return Object.values(result[0])[0] === 1;
179
- });
180
- }
181
- disconnect() {
182
- return __awaiter(this, void 0, void 0, function* () {
183
- yield this.close();
184
- });
185
- }
186
- }
187
- module.exports = KeyvSqlite;
188
- //# sourceMappingURL=index.js.map
114
+ yield* iterate(0, this.opts, this.query);
115
+ }
116
+ async has(key) {
117
+ const exists = `SELECT EXISTS ( SELECT * FROM ${this.opts.table} WHERE key = ? )`;
118
+ const result = await this.query(exists, key);
119
+ return Object.values(result[0])[0] === 1;
120
+ }
121
+ async disconnect() {
122
+ await this.close();
123
+ }
124
+ };
125
+ var src_default = KeyvSqlite;
126
+ export {
127
+ KeyvSqlite,
128
+ src_default as default
129
+ };
package/package.json CHANGED
@@ -1,47 +1,42 @@
1
1
  {
2
2
  "name": "@keyv/sqlite",
3
- "version": "3.6.7",
3
+ "version": "4.0.1",
4
4
  "description": "SQLite storage adapter for Keyv",
5
- "main": "./dist/index.js",
6
- "types": "./dist/index.d.ts",
5
+ "type": "module",
6
+ "main": "dist/index.cjs",
7
+ "module": "dist/index.js",
8
+ "types": "dist/index.d.ts",
9
+ "exports": {
10
+ ".": {
11
+ "require": "./dist/index.cjs",
12
+ "import": "./dist/index.js"
13
+ }
14
+ },
7
15
  "scripts": {
8
- "build": "tsc --project tsconfig.dist.json",
16
+ "build": "rm -rf dist && tsup src/index.ts --format cjs,esm --dts --clean",
9
17
  "prepare": "yarn build",
10
- "test": "xo && c8 ava --serial",
11
- "test:ci": "xo && ava --serial",
18
+ "test": "xo --fix && vitest run --coverage",
19
+ "test:ci": "xo && vitest --run --sequence.setupFiles=list",
12
20
  "clean": "rm -rf node_modules && rm -rf ./coverage && rm -rf ./test/testdb.sqlite"
13
21
  },
14
22
  "xo": {
15
23
  "rules": {
16
- "unicorn/prefer-module": 0,
17
- "unicorn/prefer-event-target": 0,
18
- "unicorn/prefer-node-protocol": 0,
19
- "import/extensions": 0,
20
- "@typescript-eslint/no-unsafe-argument": 0,
21
- "@typescript-eslint/no-unsafe-assignment": 0,
22
- "@typescript-eslint/no-unsafe-call": 0,
23
- "@typescript-eslint/no-unsafe-return": 0,
24
- "ava/no-ignored-test-files": [
25
- "error",
26
- {
27
- "extensions": [
28
- "js",
29
- "ts"
30
- ]
31
- }
32
- ]
24
+ "import/no-named-as-default": "off",
25
+ "unicorn/prefer-module": "off",
26
+ "n/file-extension-in-import": "off",
27
+ "unicorn/prefer-event-target": "off",
28
+ "unicorn/prefer-node-protocol": "off",
29
+ "promise/prefer-await-to-then": "off",
30
+ "@typescript-eslint/use-unknown-in-catch-callback-variable": "off",
31
+ "import/extensions": "off",
32
+ "@typescript-eslint/no-unsafe-argument": "off",
33
+ "@typescript-eslint/no-unsafe-assignment": "off",
34
+ "@typescript-eslint/no-unsafe-call": "off",
35
+ "@typescript-eslint/no-unsafe-return": "off",
36
+ "import/no-extraneous-dependencies": "off",
37
+ "unicorn/prevent-abbreviations": "off"
33
38
  }
34
39
  },
35
- "ava": {
36
- "require": [
37
- "requirable",
38
- "ts-node/register"
39
- ],
40
- "extensions": [
41
- "js",
42
- "ts"
43
- ]
44
- },
45
40
  "repository": {
46
41
  "type": "git",
47
42
  "url": "git+https://github.com/jaredwray/keyv.git"
@@ -69,18 +64,18 @@
69
64
  },
70
65
  "devDependencies": {
71
66
  "@keyv/test-suite": "*",
72
- "keyv": "*",
73
- "requirable": "^1.0.5",
74
- "ts-node": "^10.9.2",
75
- "tsd": "^0.30.4"
67
+ "keyv": "^5.0.0",
68
+ "tsd": "^0.31.1",
69
+ "xo": "^0.59.3"
76
70
  },
77
71
  "tsd": {
78
72
  "directory": "test"
79
73
  },
80
74
  "engines": {
81
- "node": ">= 14"
75
+ "node": ">= 18"
82
76
  },
83
77
  "files": [
84
- "dist"
78
+ "dist",
79
+ "LICENSE"
85
80
  ]
86
81
  }
package/dist/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,oDAAkC;AAClC,+BAA+B;AAC/B,sDAA8B;AAc9B,MAAM,QAAQ,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC;AAElG,MAAM,UAAwB,SAAQ,gBAAY;IAOjD,YAAY,WAAwC;QACnD,KAAK,EAAE,CAAC;QACR,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC;QACxB,IAAI,OAAO,GAAsB;YAChC,OAAO,EAAE,QAAQ;YACjB,GAAG,EAAE,mBAAmB;SACxB,CAAC;QAEF,IAAI,OAAO,WAAW,KAAK,QAAQ,EAAE,CAAC;YACrC,OAAO,CAAC,GAAG,GAAG,WAAW,CAAC;QAC3B,CAAC;aAAM,CAAC;YACP,OAAO,mCACH,OAAO,GACP,WAAW,CACd,CAAC;QACH,CAAC;QAED,OAAO,CAAC,EAAE,GAAG,OAAO,CAAC,GAAI,CAAC,OAAO,CAAC,cAAc,EAAE,EAAE,CAAC,CAAC;QAEtD,OAAO,CAAC,OAAO,GAAG,GAAS,EAAE;YAAC,OAAA,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;gBAC7D,MAAM,EAAE,GAAG,IAAI,iBAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAG,EAAE,KAAK,CAAC,EAAE;oBACpD,IAAI,KAAK,EAAE,CAAC;wBACX,MAAM,CAAC,KAAK,CAAC,CAAC;oBACf,CAAC;yBAAM,CAAC;wBACP,IAAI,OAAO,CAAC,WAAW,EAAE,CAAC;4BACzB,EAAE,CAAC,SAAS,CAAC,aAAa,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;wBAClD,CAAC;wBAED,OAAO,CAAC,EAAE,CAAC,CAAC;oBACb,CAAC;gBACF,CAAC,CAAC,CAAC;YACJ,CAAC,CAAC;gBACD,mCAAmC;iBAClC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,IAAA,gBAAS,EAAC,EAAE,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,IAAA,gBAAS,EAAC,EAAE,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAC,CAAC,CAAC,CAAA;UAAA,CAAC;QAEzF,IAAI,CAAC,IAAI,mBACR,KAAK,EAAE,MAAM,EACb,OAAO,EAAE,GAAG,IACT,OAAO,CACV,CAAC;QAEF,IAAI,CAAC,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,KAAM,CAAC,CAAC;QAE7C,MAAM,WAAW,GAAG,8BAA8B,IAAI,CAAC,IAAI,CAAC,KAAK,gBAAgB,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,6BAA6B,CAAC;QAExI,2BAA2B;QAC3B,MAAM,SAAS,GAAgB,IAAI,CAAC,IAAI,CAAC,OAAQ,EAAE;aACjD,IAAI,CAAC,CAAM,EAAE,EAAC,EAAE,gDAAC,OAAA,EAAE,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,EAAQ,CAAC,CAAA,GAAA,CAAC;aAC5D,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC;QAE5C,IAAI,CAAC,KAAK,GAAG,CAAO,SAAS,EAAE,GAAG,SAAS,EAAE,EAAE;YAAC,OAAA,SAAS;iBACvD,IAAI,CAAC,CAAM,EAAE,EAAC,EAAE,gDAAC,OAAA,EAAE,CAAC,KAAK,CAAC,SAAS,EAAE,GAAG,SAAS,CAAC,CAAA,GAAA,CAAC,CAAA;UAAA,CAAC;QAEtD,IAAI,CAAC,KAAK,GAAG,GAAS,EAAE,gDAAC,OAAA,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,CAAC,KAAK,CAAC,CAAA,GAAA,CAAC;IACzD,CAAC;IAEK,GAAG,CAAC,GAAW;;YACpB,MAAM,MAAM,GAAG,iBAAiB,IAAI,CAAC,IAAI,CAAC,KAAM,gBAAgB,CAAC;YACjE,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACvB,OAAO,SAAS,CAAC;YAClB,CAAC;YAED,OAAO,GAAG,CAAC,KAAc,CAAC;QAC3B,CAAC;KAAA;IAEK,OAAO,CAAC,IAAc;;YAC3B,MAAM,MAAM,GAAG,iBAAiB,IAAI,CAAC,IAAI,CAAC,KAAM,gDAAgD,CAAC;YACjG,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5D,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;YAC1B,IAAI,CAAC,GAAG,CAAC,CAAC;YACV,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;gBACxB,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,CAAC,GAAgC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;gBACvF,OAAO,CAAC,CAAC,CAAC,GAAG,QAAQ,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,SAAS,CAAC;gBAC9D,CAAC,EAAE,CAAC;YACL,CAAC;YAED,OAAO,OAAO,CAAC;QAChB,CAAC;KAAA;IAEK,GAAG,CAAC,GAAW,EAAE,KAAY;;YAClC,MAAM,MAAM,GAAG,eAAe,IAAI,CAAC,IAAI,CAAC,KAAM;;;uCAGT,CAAC;YACtC,OAAO,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QACvC,CAAC;KAAA;IAEK,MAAM,CAAC,GAAW;;YACvB,MAAM,MAAM,GAAG,iBAAiB,IAAI,CAAC,IAAI,CAAC,KAAM,gBAAgB,CAAC;YACjE,MAAM,GAAG,GAAG,eAAe,IAAI,CAAC,IAAI,CAAC,KAAM,gBAAgB,CAAC;YAE5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;YACpB,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;gBACvB,OAAO,KAAK,CAAC;YACd,CAAC;YAED,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,GAAG,CAAC,CAAC;YAC3B,OAAO,IAAI,CAAC;QACb,CAAC;KAAA;IAEK,UAAU,CAAC,IAAc;;YAC9B,MAAM,GAAG,GAAG,eAAe,IAAI,CAAC,IAAI,CAAC,KAAM,gDAAgD,CAAC;YAE5F,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;YACzC,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,SAAS,CAAC,EAAE,CAAC;gBACzC,OAAO,KAAK,CAAC;YACd,CAAC;YAED,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC;YAC5C,OAAO,IAAI,CAAC;QACb,CAAC;KAAA;IAEK,KAAK;;YACV,MAAM,GAAG,GAAG,eAAe,IAAI,CAAC,IAAI,CAAC,KAAM,mBAAmB,CAAC;YAC/D,MAAM,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,SAAS,IAAI,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACrE,CAAC;KAAA;IAEO,QAAQ,CAAC,SAAkB;;YAClC,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,cAAyB,EAAE,EAAE,CAAC,IAAI,EAAE,CAAC;YAE7E,6BAA6B;YAC7B,SAAiB,OAAO,CAAC,MAAc,EAAE,OAA0B,EAAE,KAAU;;oBAC9E,MAAM,MAAM,GAAG,iBAAiB,OAAO,CAAC,KAAM,oCAAoC,CAAC;oBACnF,MAAM,QAAQ,GAAG,cAAM,KAAK,CAAC,MAAM,EAAE,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,SAAS,GAAG,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAA,CAAC;oBAC9F,MAAM,OAAO,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC;oBAC9B,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;wBAC1B,6BAAO;oBACR,CAAC;oBAED,KAAK,MAAM,KAAK,IAAI,OAAO,EAAE,CAAC;wBAC7B,MAAM,IAAI,CAAC,CAAC;wBACZ,oBAAM,CAAC,KAAK,CAAC,GAAG,EAAE,KAAK,CAAC,KAAK,CAAC,CAAA,CAAC;oBAChC,CAAC;oBAED,cAAA,KAAM,CAAC,CAAC,iBAAA,cAAA,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC,CAAA,CAAA,CAAA,CAAC;gBACzC,CAAC;aAAA;YAED,cAAA,KAAM,CAAC,CAAC,iBAAA,cAAA,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,CAAA,CAAA,CAAA,CAAC;QAC3C,CAAC;KAAA;IAEK,GAAG,CAAC,GAAW;;YACpB,MAAM,MAAM,GAAG,iCAAiC,IAAI,CAAC,IAAI,CAAC,KAAM,kBAAkB,CAAC;YACnF,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC7C,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;QAC1C,CAAC;KAAA;IAEK,UAAU;;YACf,MAAM,IAAI,CAAC,KAAK,EAAE,CAAC;QACpB,CAAC;KAAA;CACD;AAED,iBAAS,UAAU,CAAC"}
package/dist/types.d.ts DELETED
@@ -1,29 +0,0 @@
1
- import type { StoredData } from 'keyv';
2
- export type DbQuery = (sqlString: string, ...parameter: unknown[]) => Promise<any>;
3
- export type DbClose = () => Promise<void>;
4
- export type KeyvSqliteOptions = {
5
- dialect?: string;
6
- uri?: string;
7
- busyTimeout?: number;
8
- table?: string;
9
- keySize?: number;
10
- db?: string;
11
- iterationLimit?: number | string;
12
- connect?: () => Promise<{
13
- query: DbQuery;
14
- close: DbClose;
15
- }>;
16
- };
17
- export type Db = {
18
- query: DbQuery;
19
- close: DbClose;
20
- };
21
- export type IteratorOutput = AsyncGenerator<any, void, any>;
22
- export type GetOutput<Value> = Promise<Value | undefined>;
23
- export type GetManyOutput<Value> = Promise<Array<StoredData<Value | undefined>>>;
24
- export type SetOutput = Promise<any>;
25
- export type DeleteOutput = Promise<boolean>;
26
- export type DeleteManyOutput = Promise<boolean>;
27
- export type ClearOutput = Promise<void>;
28
- export type HasOutput = Promise<boolean>;
29
- export type DisconnectOutput = Promise<void>;
package/dist/types.js DELETED
@@ -1,3 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- //# sourceMappingURL=types.js.map
package/dist/types.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}