@sovereignbase/offline-kv-store 0.0.0

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.
Files changed (9) hide show
  1. package/LICENSE +201 -0
  2. package/README.md +126 -0
  3. package/dist/index.cjs +331 -0
  4. package/dist/index.cjs.map +1 -0
  5. package/dist/index.d.cts +86 -0
  6. package/dist/index.d.ts +86 -0
  7. package/dist/index.js +331 -0
  8. package/dist/index.js.map +1 -0
  9. package/package.json +87 -0
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,126 @@
1
+ [![npm version](https://img.shields.io/npm/v/@sovereignbase/offline-kv-store)](https://www.npmjs.com/package/@sovereignbase/offline-kv-store)
2
+ [![CI](https://github.com/sovereignbase/offline-kv-store/actions/workflows/ci.yaml/badge.svg?branch=master)](https://github.com/sovereignbase/offline-kv-store/actions/workflows/ci.yaml)
3
+ [![codecov](https://codecov.io/gh/sovereignbase/offline-kv-store/branch/master/graph/badge.svg)](https://codecov.io/gh/sovereignbase/offline-kv-store)
4
+ [![license](https://img.shields.io/npm/l/@sovereignbase/offline-kv-store)](LICENSE)
5
+
6
+ # offline-kv-store
7
+
8
+ Small namespace-scoped key-value storage on top of IndexedDB. It is designed for local-first browser data where each namespace maps to its own object store and operations fail with explicit error codes instead of silent fallthrough.
9
+
10
+ ## Compatibility
11
+
12
+ - Runtimes: modern browsers and runtimes that expose global `indexedDB`
13
+ - Module format: ESM and CJS.
14
+ - Required globals / APIs: `indexedDB`, `DOMException`.
15
+ - TypeScript: bundled types.
16
+
17
+ ## Goals
18
+
19
+ - Simple `put` / `get` / `has` / `delete` / `clear` API per namespace.
20
+ - Explicit error surfaces with stable `code` strings.
21
+ - Dynamic namespace creation backed by IndexedDB object stores.
22
+ - Small public surface: `KVStore`, `resolveDB`, and `destroyDB`.
23
+
24
+ ## Installation
25
+
26
+ ```sh
27
+ npm install @sovereignbase/offline-kv-store
28
+ # or
29
+ pnpm add @sovereignbase/offline-kv-store
30
+ # or
31
+ yarn add @sovereignbase/offline-kv-store
32
+ # or
33
+ bun add @sovereignbase/offline-kv-store
34
+ # or
35
+ deno add jsr:@sovereignbase/offline-kv-store
36
+ # or
37
+ vlt install jsr:@sovereignbase/offline-kv-store
38
+ ```
39
+
40
+ ## Usage
41
+
42
+ ```ts
43
+ import { KVStore } from '@sovereignbase/offline-kv-store'
44
+
45
+ const settings = new KVStore<{ value: string }>('settings')
46
+
47
+ await settings.put('theme', { value: 'dark' })
48
+
49
+ const theme = await settings.get('theme')
50
+ console.log(theme?.value) // "dark"
51
+
52
+ console.log(await settings.has('theme')) // true
53
+
54
+ await settings.delete('theme')
55
+ await settings.clear()
56
+ ```
57
+
58
+ ### Namespaces
59
+
60
+ Each `KVStore` instance is bound to one namespace:
61
+
62
+ ```ts
63
+ import { KVStore } from '@sovereignbase/offline-kv-store'
64
+
65
+ const profiles = new KVStore<{ name: string }>('profiles')
66
+ const drafts = new KVStore<{ title: string }>('drafts')
67
+
68
+ await profiles.put('alice', { name: 'Alice' })
69
+ await drafts.put('welcome', { title: 'Hello' })
70
+ ```
71
+
72
+ ### Direct database lifecycle
73
+
74
+ ```ts
75
+ import { destroyDB, resolveDB } from '@sovereignbase/offline-kv-store'
76
+
77
+ const db = await resolveDB()
78
+ console.log(db.name) // "offline-kv-store"
79
+
80
+ await destroyDB()
81
+ ```
82
+
83
+ ## Runtime Behavior
84
+
85
+ ### Browsers / IndexedDB runtimes
86
+
87
+ Namespaces are created on demand. The first operation for a new namespace may trigger an IndexedDB version upgrade to create the backing object store.
88
+
89
+ ### Validation and errors
90
+
91
+ Validation failures and runtime failures reject with errors named `KVStoreError`. The error object includes a `code` property such as:
92
+
93
+ - `NAME_WAS_INVALID`
94
+ - `DATABASE_OPEN_FAILED`
95
+ - `DATABASE_OPEN_BLOCKED`
96
+ - `DATABASE_DELETION_FAILED`
97
+ - `DATABASE_DELETION_BLOCKED`
98
+ - `INDEXED_DB_TRANSACTION_FAILED`
99
+ - `INDEXED_DB_TRANSACTION_ABORTED`
100
+
101
+ ## Tests
102
+
103
+ - Suite: unit + integration in Node, browser E2E in Playwright.
104
+ - Browser matrix: Chromium, Firefox, WebKit, mobile Chrome, mobile Safari.
105
+ - Coverage: `c8` at 100% statements / branches / functions / lines for the Node test pass.
106
+ - Command: `npm run test`
107
+
108
+ ## Benchmarks
109
+
110
+ How it was run: `npm run bench`
111
+ Environment: Node `v22.14.0` on `win32 x64` using the repository benchmark harness.
112
+
113
+ | Operation | Workload | Time | Throughput |
114
+ | ------------------------------- | -------- | --------- | -------------- |
115
+ | namespace provision + first put | 200 ops | 97.92 ms | 2,042.43 ops/s |
116
+ | put | 2000 ops | 293.87 ms | 6,805.64 ops/s |
117
+ | get | 2000 ops | 516.10 ms | 3,875.20 ops/s |
118
+ | has | 2000 ops | 565.26 ms | 3,538.22 ops/s |
119
+ | delete | 2000 ops | 823.03 ms | 2,430.05 ops/s |
120
+ | clear | 1 op | 3.58 ms | 279.30 ops/s |
121
+
122
+ Results vary by machine and runtime. These numbers come from the included Node benchmark harness, not from an in-browser benchmark.
123
+
124
+ ## License
125
+
126
+ Apache-2.0
package/dist/index.cjs ADDED
@@ -0,0 +1,331 @@
1
+ "use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }/*
2
+ * Copyright 2026 Sovereignbase
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+
17
+
18
+ // src/.errors/class.ts
19
+ var KVStoreError = class extends Error {
20
+ /**
21
+ * The machine-readable error code.
22
+ */
23
+
24
+ /**
25
+ * Creates a new `KVStoreError`.
26
+ *
27
+ * @param code The machine-readable error code.
28
+ * @param message A human-readable detail message.
29
+ */
30
+ constructor(code, message) {
31
+ const detail = _nullishCoalesce(message, () => ( code));
32
+ super(`{@sovereignbase/offline-kv-store} ${detail}`);
33
+ this.code = code;
34
+ this.name = "KVStoreError";
35
+ }
36
+ };
37
+
38
+ // src/.helpers/index.ts
39
+ function isKey(value, label) {
40
+ if (typeof value !== "string" || value.length <= 0) {
41
+ throw new KVStoreError(
42
+ "NAME_WAS_INVALID",
43
+ `${label} must be a non-empty string`
44
+ );
45
+ }
46
+ }
47
+
48
+ // src/indexedDB/index.ts
49
+ var DB_NAME = "offline-kv-store";
50
+ var dbRef = null;
51
+ var dbPromise = null;
52
+ var ensureStoreChain = Promise.resolve();
53
+ function cacheDB(db) {
54
+ db.onversionchange = () => {
55
+ if (dbRef === db) {
56
+ dbRef = null;
57
+ dbPromise = null;
58
+ }
59
+ db.close();
60
+ };
61
+ dbRef = db;
62
+ dbPromise = Promise.resolve(db);
63
+ return db;
64
+ }
65
+ function openDB(version, onUpgrade) {
66
+ return new Promise((resolve, reject) => {
67
+ const request = version === void 0 ? indexedDB.open(DB_NAME) : indexedDB.open(DB_NAME, version);
68
+ request.onupgradeneeded = () => {
69
+ _optionalChain([onUpgrade, 'optionalCall', _ => _(request.result)]);
70
+ };
71
+ request.onsuccess = () => resolve(cacheDB(request.result));
72
+ request.onerror = () => reject(new KVStoreError("DATABASE_OPEN_FAILED", _optionalChain([request, 'access', _2 => _2.error, 'optionalAccess', _3 => _3.message])));
73
+ request.onblocked = (event) => reject(
74
+ new KVStoreError(
75
+ "DATABASE_OPEN_BLOCKED",
76
+ `IndexedDB open blocked for "${DB_NAME}" (oldVersion=${event.oldVersion}, newVersion=${event.newVersion})`
77
+ )
78
+ );
79
+ });
80
+ }
81
+ function closeDB() {
82
+ if (dbRef) dbRef.close();
83
+ dbRef = null;
84
+ dbPromise = null;
85
+ }
86
+ async function resolveDB() {
87
+ if (dbRef) return dbRef;
88
+ if (!dbPromise) {
89
+ dbPromise = openDB().catch((error) => {
90
+ dbPromise = null;
91
+ throw error;
92
+ });
93
+ }
94
+ return dbPromise;
95
+ }
96
+ async function destroyDB() {
97
+ closeDB();
98
+ await new Promise((resolve, reject) => {
99
+ const request = indexedDB.deleteDatabase(DB_NAME);
100
+ request.onsuccess = () => resolve();
101
+ request.onerror = () => reject(
102
+ new KVStoreError("DATABASE_DELETION_FAILED", _optionalChain([request, 'access', _4 => _4.error, 'optionalAccess', _5 => _5.message]))
103
+ );
104
+ request.onblocked = (event) => reject(
105
+ new KVStoreError(
106
+ "DATABASE_DELETION_BLOCKED",
107
+ `IndexedDB delete blocked for "${DB_NAME}" (oldVersion=${event.oldVersion}, newVersion=${event.newVersion})`
108
+ )
109
+ );
110
+ });
111
+ }
112
+ function assertStore(storeName) {
113
+ const task = ensureStoreChain.then(async () => {
114
+ const db = await resolveDB();
115
+ if (db.objectStoreNames.contains(storeName)) return;
116
+ const nextVersion = db.version + 1;
117
+ closeDB();
118
+ await openDB(nextVersion, (upgradeDb) => {
119
+ if (!upgradeDb.objectStoreNames.contains(storeName)) {
120
+ upgradeDb.createObjectStore(storeName, { keyPath: "key" });
121
+ }
122
+ });
123
+ });
124
+ ensureStoreChain = task.catch(() => {
125
+ });
126
+ return task;
127
+ }
128
+
129
+ // src/KVStore/class.ts
130
+ var KVStore = class {
131
+ /**
132
+ * The namespace backing this store instance.
133
+ */
134
+
135
+ /**
136
+ * A promise that fulfills after the namespace store is available.
137
+ */
138
+
139
+ /**
140
+ * Creates a new `KVStore` bound to the given namespace.
141
+ *
142
+ * @param namespace The object store name backing the instance.
143
+ */
144
+ constructor(namespace) {
145
+ isKey(namespace, "namespace");
146
+ this.namespace = namespace;
147
+ this.ready = assertStore(namespace);
148
+ }
149
+ /**
150
+ * Returns the value associated with the given key.
151
+ *
152
+ * @param key The key to look up.
153
+ * @returns A promise that fulfills with the stored value, if any.
154
+ */
155
+ async get(key) {
156
+ isKey(key, "key");
157
+ await this.ready;
158
+ const db = await resolveDB();
159
+ const row = await new Promise((resolve, reject) => {
160
+ try {
161
+ const tx = db.transaction(this.namespace, "readonly");
162
+ const store = tx.objectStore(this.namespace);
163
+ const request = store.get(key);
164
+ tx.oncomplete = () => resolve(request.result);
165
+ tx.onerror = () => reject(
166
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", _optionalChain([tx, 'access', _6 => _6.error, 'optionalAccess', _7 => _7.message]))
167
+ );
168
+ tx.onabort = () => reject(
169
+ new KVStoreError(
170
+ "INDEXED_DB_TRANSACTION_ABORTED",
171
+ _optionalChain([tx, 'access', _8 => _8.error, 'optionalAccess', _9 => _9.message])
172
+ )
173
+ );
174
+ } catch (error) {
175
+ reject(
176
+ new KVStoreError(
177
+ "INDEXED_DB_TRANSACTION_FAILED",
178
+ error instanceof Error ? error.message : void 0
179
+ )
180
+ );
181
+ }
182
+ });
183
+ return _nullishCoalesce(_optionalChain([row, 'optionalAccess', _10 => _10.value]), () => ( void 0));
184
+ }
185
+ /**
186
+ * Returns whether the given key exists.
187
+ *
188
+ * @param key The key to look up.
189
+ * @returns A promise that fulfills with `true` if the key exists.
190
+ */
191
+ async has(key) {
192
+ isKey(key, "key");
193
+ await this.ready;
194
+ const db = await resolveDB();
195
+ return new Promise((resolve, reject) => {
196
+ try {
197
+ const tx = db.transaction(this.namespace, "readonly");
198
+ const store = tx.objectStore(this.namespace);
199
+ const request = typeof store.getKey === "function" ? store.getKey(key) : store.get(key);
200
+ tx.oncomplete = () => resolve(request.result !== void 0);
201
+ tx.onerror = () => reject(
202
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", _optionalChain([tx, 'access', _11 => _11.error, 'optionalAccess', _12 => _12.message]))
203
+ );
204
+ tx.onabort = () => reject(
205
+ new KVStoreError(
206
+ "INDEXED_DB_TRANSACTION_ABORTED",
207
+ _optionalChain([tx, 'access', _13 => _13.error, 'optionalAccess', _14 => _14.message])
208
+ )
209
+ );
210
+ } catch (error) {
211
+ reject(
212
+ new KVStoreError(
213
+ "INDEXED_DB_TRANSACTION_FAILED",
214
+ error instanceof Error ? error.message : void 0
215
+ )
216
+ );
217
+ }
218
+ });
219
+ }
220
+ /**
221
+ * Stores a value for the given key.
222
+ *
223
+ * @param key The key to write.
224
+ * @param value The value to associate with `key`.
225
+ * @returns A promise that fulfills when the write completes.
226
+ */
227
+ async put(key, value) {
228
+ isKey(key, "key");
229
+ await this.ready;
230
+ const db = await resolveDB();
231
+ await new Promise((resolve, reject) => {
232
+ try {
233
+ const tx = db.transaction(this.namespace, "readwrite");
234
+ const store = tx.objectStore(this.namespace);
235
+ const row = { key, value };
236
+ store.put(row);
237
+ tx.oncomplete = () => resolve();
238
+ tx.onerror = () => reject(
239
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", _optionalChain([tx, 'access', _15 => _15.error, 'optionalAccess', _16 => _16.message]))
240
+ );
241
+ tx.onabort = () => reject(
242
+ new KVStoreError(
243
+ "INDEXED_DB_TRANSACTION_ABORTED",
244
+ _optionalChain([tx, 'access', _17 => _17.error, 'optionalAccess', _18 => _18.message])
245
+ )
246
+ );
247
+ } catch (error) {
248
+ reject(
249
+ new KVStoreError(
250
+ "INDEXED_DB_TRANSACTION_FAILED",
251
+ error instanceof Error ? error.message : void 0
252
+ )
253
+ );
254
+ }
255
+ });
256
+ }
257
+ /**
258
+ * Deletes the value associated with the given key.
259
+ *
260
+ * @param key The key to delete.
261
+ * @returns A promise that fulfills when the deletion completes.
262
+ */
263
+ async delete(key) {
264
+ isKey(key, "key");
265
+ await this.ready;
266
+ const db = await resolveDB();
267
+ await new Promise((resolve, reject) => {
268
+ try {
269
+ const tx = db.transaction(this.namespace, "readwrite");
270
+ const store = tx.objectStore(this.namespace);
271
+ store.delete(key);
272
+ tx.oncomplete = () => resolve();
273
+ tx.onerror = () => reject(
274
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", _optionalChain([tx, 'access', _19 => _19.error, 'optionalAccess', _20 => _20.message]))
275
+ );
276
+ tx.onabort = () => reject(
277
+ new KVStoreError(
278
+ "INDEXED_DB_TRANSACTION_ABORTED",
279
+ _optionalChain([tx, 'access', _21 => _21.error, 'optionalAccess', _22 => _22.message])
280
+ )
281
+ );
282
+ } catch (error) {
283
+ reject(
284
+ new KVStoreError(
285
+ "INDEXED_DB_TRANSACTION_FAILED",
286
+ error instanceof Error ? error.message : void 0
287
+ )
288
+ );
289
+ }
290
+ });
291
+ }
292
+ /**
293
+ * Deletes every value stored in the namespace.
294
+ *
295
+ * @returns A promise that fulfills when the namespace is cleared.
296
+ */
297
+ async clear() {
298
+ await this.ready;
299
+ const db = await resolveDB();
300
+ await new Promise((resolve, reject) => {
301
+ try {
302
+ const tx = db.transaction(this.namespace, "readwrite");
303
+ const store = tx.objectStore(this.namespace);
304
+ store.clear();
305
+ tx.oncomplete = () => resolve();
306
+ tx.onerror = () => reject(
307
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", _optionalChain([tx, 'access', _23 => _23.error, 'optionalAccess', _24 => _24.message]))
308
+ );
309
+ tx.onabort = () => reject(
310
+ new KVStoreError(
311
+ "INDEXED_DB_TRANSACTION_ABORTED",
312
+ _optionalChain([tx, 'access', _25 => _25.error, 'optionalAccess', _26 => _26.message])
313
+ )
314
+ );
315
+ } catch (error) {
316
+ reject(
317
+ new KVStoreError(
318
+ "INDEXED_DB_TRANSACTION_FAILED",
319
+ error instanceof Error ? error.message : void 0
320
+ )
321
+ );
322
+ }
323
+ });
324
+ }
325
+ };
326
+
327
+
328
+
329
+
330
+ exports.KVStore = KVStore; exports.destroyDB = destroyDB; exports.resolveDB = resolveDB;
331
+ //# sourceMappingURL=index.cjs.map
package/dist/index.cjs.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["c:\\Users\\jorts\\offline-kv-store\\dist\\index.cjs"],"names":[],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,IAAI,aAAa,EAAE,MAAM,QAAQ,MAAM;AACvC;AACA;AACA;AACA,EAAE;AACF;AACA;AACA;AACA;AACA;AACA;AACA,EAAE,WAAW,CAAC,IAAI,EAAE,OAAO,EAAE;AAC7B,IAAI,MAAM,OAAO,mBAAE,OAAQ,UAAG,MAAI;AAClC,IAAI,KAAK,CAAC,CAAC,kCAAkC,EAAE,MAAM,CAAC,CAAA;AACA,IAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,MAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,MAAA;AACA,MAAA;AACA,IAAA;AACA,IAAA;AACA,EAAA;AACA,EAAA;AACA,EAAA;AACA,EAAA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,sBAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,QAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA,EAAA;AACA,EAAA;AACA,EAAA;AACA;AACA;AACA,EAAA;AACA,EAAA;AACA,IAAA;AACA,MAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA,EAAA;AACA;AACA;AACA,EAAA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,QAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA,EAAA;AACA,EAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA;AACA;AACA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,4BAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,YAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,4BAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,YAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,4BAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,YAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,4BAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,YAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA,EAAA;AACA,IAAA;AACA,IAAA;AACA,IAAA;AACA,MAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,QAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,4BAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,QAAA;AACA,UAAA;AACA,YAAA;AACA,YAAA;AACA,UAAA;AACA,QAAA;AACA,MAAA;AACA,IAAA;AACA,EAAA;AACA;AACA;AACA;AACA;AACA;AACA","file":"C:\\Users\\jorts\\offline-kv-store\\dist\\index.cjs","sourcesContent":[null]}
package/dist/index.d.cts ADDED
@@ -0,0 +1,86 @@
1
+ /**
2
+ * A key-value store backed by a single IndexedDB object store namespace.
3
+ *
4
+ * @typeParam T The stored value type.
5
+ */
6
+ declare class KVStore<T extends Record<string, unknown>> {
7
+ /**
8
+ * The namespace backing this store instance.
9
+ */
10
+ readonly namespace: string;
11
+ /**
12
+ * A promise that fulfills after the namespace store is available.
13
+ */
14
+ private readonly ready;
15
+ /**
16
+ * Creates a new `KVStore` bound to the given namespace.
17
+ *
18
+ * @param namespace The object store name backing the instance.
19
+ */
20
+ constructor(namespace: string);
21
+ /**
22
+ * Returns the value associated with the given key.
23
+ *
24
+ * @param key The key to look up.
25
+ * @returns A promise that fulfills with the stored value, if any.
26
+ */
27
+ get(key: string): Promise<T | undefined>;
28
+ /**
29
+ * Returns whether the given key exists.
30
+ *
31
+ * @param key The key to look up.
32
+ * @returns A promise that fulfills with `true` if the key exists.
33
+ */
34
+ has(key: string): Promise<boolean>;
35
+ /**
36
+ * Stores a value for the given key.
37
+ *
38
+ * @param key The key to write.
39
+ * @param value The value to associate with `key`.
40
+ * @returns A promise that fulfills when the write completes.
41
+ */
42
+ put(key: string, value: T): Promise<void>;
43
+ /**
44
+ * Deletes the value associated with the given key.
45
+ *
46
+ * @param key The key to delete.
47
+ * @returns A promise that fulfills when the deletion completes.
48
+ */
49
+ delete(key: string): Promise<void>;
50
+ /**
51
+ * Deletes every value stored in the namespace.
52
+ *
53
+ * @returns A promise that fulfills when the namespace is cleared.
54
+ */
55
+ clear(): Promise<void>;
56
+ }
57
+
58
+ /**
59
+ * A stored key-value entry.
60
+ *
61
+ * @typeParam T The stored value type.
62
+ */
63
+ type Row<T> = {
64
+ key: string;
65
+ value: T;
66
+ };
67
+
68
+ /**
69
+ * Error codes thrown by the offline KV store.
70
+ */
71
+ type KVStoreErrorCode = 'DATABASE_DELETION_BLOCKED' | 'DATABASE_DELETION_FAILED' | 'DATABASE_OPEN_BLOCKED' | 'DATABASE_OPEN_FAILED' | 'INDEXED_DB_TRANSACTION_FAILED' | 'INDEXED_DB_TRANSACTION_ABORTED' | 'NAME_WAS_INVALID';
72
+
73
+ /**
74
+ * Resolves the active database connection.
75
+ *
76
+ * @returns A promise that fulfills with the open database.
77
+ */
78
+ declare function resolveDB(): Promise<IDBDatabase>;
79
+ /**
80
+ * Deletes the backing IndexedDB database.
81
+ *
82
+ * @returns A promise that fulfills when deletion completes.
83
+ */
84
+ declare function destroyDB(): Promise<void>;
85
+
86
+ export { KVStore, type KVStoreErrorCode, type Row, destroyDB, resolveDB };
package/dist/index.d.ts ADDED
@@ -0,0 +1,86 @@
1
+ /**
2
+ * A key-value store backed by a single IndexedDB object store namespace.
3
+ *
4
+ * @typeParam T The stored value type.
5
+ */
6
+ declare class KVStore<T extends Record<string, unknown>> {
7
+ /**
8
+ * The namespace backing this store instance.
9
+ */
10
+ readonly namespace: string;
11
+ /**
12
+ * A promise that fulfills after the namespace store is available.
13
+ */
14
+ private readonly ready;
15
+ /**
16
+ * Creates a new `KVStore` bound to the given namespace.
17
+ *
18
+ * @param namespace The object store name backing the instance.
19
+ */
20
+ constructor(namespace: string);
21
+ /**
22
+ * Returns the value associated with the given key.
23
+ *
24
+ * @param key The key to look up.
25
+ * @returns A promise that fulfills with the stored value, if any.
26
+ */
27
+ get(key: string): Promise<T | undefined>;
28
+ /**
29
+ * Returns whether the given key exists.
30
+ *
31
+ * @param key The key to look up.
32
+ * @returns A promise that fulfills with `true` if the key exists.
33
+ */
34
+ has(key: string): Promise<boolean>;
35
+ /**
36
+ * Stores a value for the given key.
37
+ *
38
+ * @param key The key to write.
39
+ * @param value The value to associate with `key`.
40
+ * @returns A promise that fulfills when the write completes.
41
+ */
42
+ put(key: string, value: T): Promise<void>;
43
+ /**
44
+ * Deletes the value associated with the given key.
45
+ *
46
+ * @param key The key to delete.
47
+ * @returns A promise that fulfills when the deletion completes.
48
+ */
49
+ delete(key: string): Promise<void>;
50
+ /**
51
+ * Deletes every value stored in the namespace.
52
+ *
53
+ * @returns A promise that fulfills when the namespace is cleared.
54
+ */
55
+ clear(): Promise<void>;
56
+ }
57
+
58
+ /**
59
+ * A stored key-value entry.
60
+ *
61
+ * @typeParam T The stored value type.
62
+ */
63
+ type Row<T> = {
64
+ key: string;
65
+ value: T;
66
+ };
67
+
68
+ /**
69
+ * Error codes thrown by the offline KV store.
70
+ */
71
+ type KVStoreErrorCode = 'DATABASE_DELETION_BLOCKED' | 'DATABASE_DELETION_FAILED' | 'DATABASE_OPEN_BLOCKED' | 'DATABASE_OPEN_FAILED' | 'INDEXED_DB_TRANSACTION_FAILED' | 'INDEXED_DB_TRANSACTION_ABORTED' | 'NAME_WAS_INVALID';
72
+
73
+ /**
74
+ * Resolves the active database connection.
75
+ *
76
+ * @returns A promise that fulfills with the open database.
77
+ */
78
+ declare function resolveDB(): Promise<IDBDatabase>;
79
+ /**
80
+ * Deletes the backing IndexedDB database.
81
+ *
82
+ * @returns A promise that fulfills when deletion completes.
83
+ */
84
+ declare function destroyDB(): Promise<void>;
85
+
86
+ export { KVStore, type KVStoreErrorCode, type Row, destroyDB, resolveDB };
package/dist/index.js ADDED
@@ -0,0 +1,331 @@
1
+ /*
2
+ * Copyright 2026 Sovereignbase
3
+ *
4
+ * Licensed under the Apache License, Version 2.0 (the "License");
5
+ * you may not use this file except in compliance with the License.
6
+ * You may obtain a copy of the License at
7
+ *
8
+ * http://www.apache.org/licenses/LICENSE-2.0
9
+ *
10
+ * Unless required by applicable law or agreed to in writing, software
11
+ * distributed under the License is distributed on an "AS IS" BASIS,
12
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13
+ * See the License for the specific language governing permissions and
14
+ * limitations under the License.
15
+ */
16
+
17
+
18
+ // src/.errors/class.ts
19
+ var KVStoreError = class extends Error {
20
+ /**
21
+ * The machine-readable error code.
22
+ */
23
+ code;
24
+ /**
25
+ * Creates a new `KVStoreError`.
26
+ *
27
+ * @param code The machine-readable error code.
28
+ * @param message A human-readable detail message.
29
+ */
30
+ constructor(code, message) {
31
+ const detail = message ?? code;
32
+ super(`{@sovereignbase/offline-kv-store} ${detail}`);
33
+ this.code = code;
34
+ this.name = "KVStoreError";
35
+ }
36
+ };
37
+
38
+ // src/.helpers/index.ts
39
+ function isKey(value, label) {
40
+ if (typeof value !== "string" || value.length <= 0) {
41
+ throw new KVStoreError(
42
+ "NAME_WAS_INVALID",
43
+ `${label} must be a non-empty string`
44
+ );
45
+ }
46
+ }
47
+
48
+ // src/indexedDB/index.ts
49
+ var DB_NAME = "offline-kv-store";
50
+ var dbRef = null;
51
+ var dbPromise = null;
52
+ var ensureStoreChain = Promise.resolve();
53
+ function cacheDB(db) {
54
+ db.onversionchange = () => {
55
+ if (dbRef === db) {
56
+ dbRef = null;
57
+ dbPromise = null;
58
+ }
59
+ db.close();
60
+ };
61
+ dbRef = db;
62
+ dbPromise = Promise.resolve(db);
63
+ return db;
64
+ }
65
+ function openDB(version, onUpgrade) {
66
+ return new Promise((resolve, reject) => {
67
+ const request = version === void 0 ? indexedDB.open(DB_NAME) : indexedDB.open(DB_NAME, version);
68
+ request.onupgradeneeded = () => {
69
+ onUpgrade?.(request.result);
70
+ };
71
+ request.onsuccess = () => resolve(cacheDB(request.result));
72
+ request.onerror = () => reject(new KVStoreError("DATABASE_OPEN_FAILED", request.error?.message));
73
+ request.onblocked = (event) => reject(
74
+ new KVStoreError(
75
+ "DATABASE_OPEN_BLOCKED",
76
+ `IndexedDB open blocked for "${DB_NAME}" (oldVersion=${event.oldVersion}, newVersion=${event.newVersion})`
77
+ )
78
+ );
79
+ });
80
+ }
81
+ function closeDB() {
82
+ if (dbRef) dbRef.close();
83
+ dbRef = null;
84
+ dbPromise = null;
85
+ }
86
+ async function resolveDB() {
87
+ if (dbRef) return dbRef;
88
+ if (!dbPromise) {
89
+ dbPromise = openDB().catch((error) => {
90
+ dbPromise = null;
91
+ throw error;
92
+ });
93
+ }
94
+ return dbPromise;
95
+ }
96
+ async function destroyDB() {
97
+ closeDB();
98
+ await new Promise((resolve, reject) => {
99
+ const request = indexedDB.deleteDatabase(DB_NAME);
100
+ request.onsuccess = () => resolve();
101
+ request.onerror = () => reject(
102
+ new KVStoreError("DATABASE_DELETION_FAILED", request.error?.message)
103
+ );
104
+ request.onblocked = (event) => reject(
105
+ new KVStoreError(
106
+ "DATABASE_DELETION_BLOCKED",
107
+ `IndexedDB delete blocked for "${DB_NAME}" (oldVersion=${event.oldVersion}, newVersion=${event.newVersion})`
108
+ )
109
+ );
110
+ });
111
+ }
112
+ function assertStore(storeName) {
113
+ const task = ensureStoreChain.then(async () => {
114
+ const db = await resolveDB();
115
+ if (db.objectStoreNames.contains(storeName)) return;
116
+ const nextVersion = db.version + 1;
117
+ closeDB();
118
+ await openDB(nextVersion, (upgradeDb) => {
119
+ if (!upgradeDb.objectStoreNames.contains(storeName)) {
120
+ upgradeDb.createObjectStore(storeName, { keyPath: "key" });
121
+ }
122
+ });
123
+ });
124
+ ensureStoreChain = task.catch(() => {
125
+ });
126
+ return task;
127
+ }
128
+
129
+ // src/KVStore/class.ts
130
+ var KVStore = class {
131
+ /**
132
+ * The namespace backing this store instance.
133
+ */
134
+ namespace;
135
+ /**
136
+ * A promise that fulfills after the namespace store is available.
137
+ */
138
+ ready;
139
+ /**
140
+ * Creates a new `KVStore` bound to the given namespace.
141
+ *
142
+ * @param namespace The object store name backing the instance.
143
+ */
144
+ constructor(namespace) {
145
+ isKey(namespace, "namespace");
146
+ this.namespace = namespace;
147
+ this.ready = assertStore(namespace);
148
+ }
149
+ /**
150
+ * Returns the value associated with the given key.
151
+ *
152
+ * @param key The key to look up.
153
+ * @returns A promise that fulfills with the stored value, if any.
154
+ */
155
+ async get(key) {
156
+ isKey(key, "key");
157
+ await this.ready;
158
+ const db = await resolveDB();
159
+ const row = await new Promise((resolve, reject) => {
160
+ try {
161
+ const tx = db.transaction(this.namespace, "readonly");
162
+ const store = tx.objectStore(this.namespace);
163
+ const request = store.get(key);
164
+ tx.oncomplete = () => resolve(request.result);
165
+ tx.onerror = () => reject(
166
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", tx.error?.message)
167
+ );
168
+ tx.onabort = () => reject(
169
+ new KVStoreError(
170
+ "INDEXED_DB_TRANSACTION_ABORTED",
171
+ tx.error?.message
172
+ )
173
+ );
174
+ } catch (error) {
175
+ reject(
176
+ new KVStoreError(
177
+ "INDEXED_DB_TRANSACTION_FAILED",
178
+ error instanceof Error ? error.message : void 0
179
+ )
180
+ );
181
+ }
182
+ });
183
+ return row?.value ?? void 0;
184
+ }
185
+ /**
186
+ * Returns whether the given key exists.
187
+ *
188
+ * @param key The key to look up.
189
+ * @returns A promise that fulfills with `true` if the key exists.
190
+ */
191
+ async has(key) {
192
+ isKey(key, "key");
193
+ await this.ready;
194
+ const db = await resolveDB();
195
+ return new Promise((resolve, reject) => {
196
+ try {
197
+ const tx = db.transaction(this.namespace, "readonly");
198
+ const store = tx.objectStore(this.namespace);
199
+ const request = typeof store.getKey === "function" ? store.getKey(key) : store.get(key);
200
+ tx.oncomplete = () => resolve(request.result !== void 0);
201
+ tx.onerror = () => reject(
202
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", tx.error?.message)
203
+ );
204
+ tx.onabort = () => reject(
205
+ new KVStoreError(
206
+ "INDEXED_DB_TRANSACTION_ABORTED",
207
+ tx.error?.message
208
+ )
209
+ );
210
+ } catch (error) {
211
+ reject(
212
+ new KVStoreError(
213
+ "INDEXED_DB_TRANSACTION_FAILED",
214
+ error instanceof Error ? error.message : void 0
215
+ )
216
+ );
217
+ }
218
+ });
219
+ }
220
+ /**
221
+ * Stores a value for the given key.
222
+ *
223
+ * @param key The key to write.
224
+ * @param value The value to associate with `key`.
225
+ * @returns A promise that fulfills when the write completes.
226
+ */
227
+ async put(key, value) {
228
+ isKey(key, "key");
229
+ await this.ready;
230
+ const db = await resolveDB();
231
+ await new Promise((resolve, reject) => {
232
+ try {
233
+ const tx = db.transaction(this.namespace, "readwrite");
234
+ const store = tx.objectStore(this.namespace);
235
+ const row = { key, value };
236
+ store.put(row);
237
+ tx.oncomplete = () => resolve();
238
+ tx.onerror = () => reject(
239
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", tx.error?.message)
240
+ );
241
+ tx.onabort = () => reject(
242
+ new KVStoreError(
243
+ "INDEXED_DB_TRANSACTION_ABORTED",
244
+ tx.error?.message
245
+ )
246
+ );
247
+ } catch (error) {
248
+ reject(
249
+ new KVStoreError(
250
+ "INDEXED_DB_TRANSACTION_FAILED",
251
+ error instanceof Error ? error.message : void 0
252
+ )
253
+ );
254
+ }
255
+ });
256
+ }
257
+ /**
258
+ * Deletes the value associated with the given key.
259
+ *
260
+ * @param key The key to delete.
261
+ * @returns A promise that fulfills when the deletion completes.
262
+ */
263
+ async delete(key) {
264
+ isKey(key, "key");
265
+ await this.ready;
266
+ const db = await resolveDB();
267
+ await new Promise((resolve, reject) => {
268
+ try {
269
+ const tx = db.transaction(this.namespace, "readwrite");
270
+ const store = tx.objectStore(this.namespace);
271
+ store.delete(key);
272
+ tx.oncomplete = () => resolve();
273
+ tx.onerror = () => reject(
274
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", tx.error?.message)
275
+ );
276
+ tx.onabort = () => reject(
277
+ new KVStoreError(
278
+ "INDEXED_DB_TRANSACTION_ABORTED",
279
+ tx.error?.message
280
+ )
281
+ );
282
+ } catch (error) {
283
+ reject(
284
+ new KVStoreError(
285
+ "INDEXED_DB_TRANSACTION_FAILED",
286
+ error instanceof Error ? error.message : void 0
287
+ )
288
+ );
289
+ }
290
+ });
291
+ }
292
+ /**
293
+ * Deletes every value stored in the namespace.
294
+ *
295
+ * @returns A promise that fulfills when the namespace is cleared.
296
+ */
297
+ async clear() {
298
+ await this.ready;
299
+ const db = await resolveDB();
300
+ await new Promise((resolve, reject) => {
301
+ try {
302
+ const tx = db.transaction(this.namespace, "readwrite");
303
+ const store = tx.objectStore(this.namespace);
304
+ store.clear();
305
+ tx.oncomplete = () => resolve();
306
+ tx.onerror = () => reject(
307
+ new KVStoreError("INDEXED_DB_TRANSACTION_FAILED", tx.error?.message)
308
+ );
309
+ tx.onabort = () => reject(
310
+ new KVStoreError(
311
+ "INDEXED_DB_TRANSACTION_ABORTED",
312
+ tx.error?.message
313
+ )
314
+ );
315
+ } catch (error) {
316
+ reject(
317
+ new KVStoreError(
318
+ "INDEXED_DB_TRANSACTION_FAILED",
319
+ error instanceof Error ? error.message : void 0
320
+ )
321
+ );
322
+ }
323
+ });
324
+ }
325
+ };
326
+ export {
327
+ KVStore,
328
+ destroyDB,
329
+ resolveDB
330
+ };
331
+ //# sourceMappingURL=index.js.map
package/dist/index.js.map ADDED
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/.errors/class.ts","../src/.helpers/index.ts","../src/indexedDB/index.ts","../src/KVStore/class.ts"],"sourcesContent":["/**\n * Error codes thrown by the offline KV store.\n */\nexport type KVStoreErrorCode =\n | 'DATABASE_DELETION_BLOCKED'\n | 'DATABASE_DELETION_FAILED'\n | 'DATABASE_OPEN_BLOCKED'\n | 'DATABASE_OPEN_FAILED'\n | 'INDEXED_DB_TRANSACTION_FAILED'\n | 'INDEXED_DB_TRANSACTION_ABORTED'\n | 'NAME_WAS_INVALID'\n\n/**\n * An error thrown by the offline KV store.\n */\nexport class KVStoreError extends Error {\n /**\n * The machine-readable error code.\n */\n readonly code: KVStoreErrorCode\n\n /**\n * Creates a new `KVStoreError`.\n *\n * @param code The machine-readable error code.\n * @param message A human-readable detail message.\n */\n constructor(code: KVStoreErrorCode, message?: string) {\n const detail = message ?? code\n super(`{@sovereignbase/offline-kv-store} ${detail}`)\n this.code = code\n this.name = 'KVStoreError'\n }\n}\n","import { KVStoreError } from '../.errors/class.js'\n\n/**\n * Verifies that a namespace or key is a non-empty string.\n *\n * @param value The value to validate.\n * @param label The parameter name to include in the error message.\n * @throws {KVStoreError} Thrown if `value` is not a non-empty string.\n */\nexport function isKey(value: string, label: string): void {\n if (typeof value !== 'string' || value.length <= 0) {\n throw new KVStoreError(\n 'NAME_WAS_INVALID',\n `${label} must be a non-empty string`\n )\n }\n}\n","import { KVStoreError } from '../.errors/class.js'\n\nconst DB_NAME = 'offline-kv-store'\n\nlet dbRef: IDBDatabase | null = null\nlet dbPromise: Promise<IDBDatabase> | null = null\nlet ensureStoreChain: Promise<void> = Promise.resolve()\n\n/**\n * Caches an open database connection and wires version-change cleanup.\n *\n * @param db The database connection to cache.\n * @returns The cached database connection.\n */\nfunction cacheDB(db: IDBDatabase): IDBDatabase {\n db.onversionchange = () => {\n if (dbRef === db) {\n dbRef = null\n dbPromise = null\n }\n\n db.close()\n }\n\n dbRef = db\n dbPromise = Promise.resolve(db)\n\n return db\n}\n\n/**\n * Opens the backing IndexedDB database.\n *\n * @param version The database version to open.\n * @param onUpgrade The callback invoked during an upgrade transaction.\n * @returns A promise that fulfills with the open database.\n */\nfunction openDB(\n version?: number,\n onUpgrade?: (db: IDBDatabase) => void\n): Promise<IDBDatabase> {\n return new Promise((resolve, reject) => {\n const request =\n version === undefined\n ? indexedDB.open(DB_NAME)\n : indexedDB.open(DB_NAME, version)\n\n request.onupgradeneeded = () => {\n onUpgrade?.(request.result)\n }\n\n request.onsuccess = () => resolve(cacheDB(request.result))\n request.onerror = () =>\n reject(new KVStoreError('DATABASE_OPEN_FAILED', request.error?.message))\n request.onblocked = (event) =>\n reject(\n new KVStoreError(\n 'DATABASE_OPEN_BLOCKED',\n `IndexedDB open blocked for \"${DB_NAME}\" (oldVersion=${event.oldVersion}, newVersion=${event.newVersion})`\n )\n )\n })\n}\n\n/**\n * Closes the cached database connection, if any.\n */\nfunction closeDB(): void {\n if (dbRef) dbRef.close()\n dbRef = null\n dbPromise = null\n}\n\n/**\n * Resolves the active database connection.\n *\n * @returns A promise that fulfills with the open database.\n */\nexport async function resolveDB(): Promise<IDBDatabase> {\n if (dbRef) return dbRef\n\n if (!dbPromise) {\n dbPromise = openDB().catch((error) => {\n dbPromise = null\n throw error\n })\n }\n\n return dbPromise\n}\n\n/**\n * Deletes the backing IndexedDB database.\n *\n * @returns A promise that fulfills when deletion completes.\n */\nexport async function destroyDB(): Promise<void> {\n closeDB()\n\n await new Promise<void>((resolve, reject) => {\n const request = indexedDB.deleteDatabase(DB_NAME)\n\n request.onsuccess = () => resolve()\n request.onerror = () =>\n reject(\n new KVStoreError('DATABASE_DELETION_FAILED', request.error?.message)\n )\n request.onblocked = (event) =>\n reject(\n new KVStoreError(\n 'DATABASE_DELETION_BLOCKED',\n `IndexedDB delete blocked for \"${DB_NAME}\" (oldVersion=${event.oldVersion}, newVersion=${event.newVersion})`\n )\n )\n })\n}\n\n/**\n * Ensures that the named object store exists.\n *\n * @param storeName The object store name to create if needed.\n * @returns A promise that fulfills after the object store is available.\n */\nexport function assertStore(storeName: string): Promise<void> {\n const task = ensureStoreChain.then(async () => {\n const db = await resolveDB()\n\n if (db.objectStoreNames.contains(storeName)) return\n\n const nextVersion = db.version + 1\n closeDB()\n\n await openDB(nextVersion, (upgradeDb) => {\n if (!upgradeDb.objectStoreNames.contains(storeName)) {\n upgradeDb.createObjectStore(storeName, { keyPath: 'key' })\n }\n })\n })\n\n ensureStoreChain = task.catch(() => {})\n return task\n}\n","import { KVStoreError } from '../.errors/class.js'\nimport type { Row } from '../.types/index.js'\nimport { isKey } from '../.helpers/index.js'\nimport { assertStore, resolveDB } from '../indexedDB/index.js'\n\n/**\n * A key-value store backed by a single IndexedDB object store namespace.\n *\n * @typeParam T The stored value type.\n */\nexport class KVStore<T extends Record<string, unknown>> {\n /**\n * The namespace backing this store instance.\n */\n public readonly namespace: string\n\n /**\n * A promise that fulfills after the namespace store is available.\n */\n private readonly ready: Promise<void>\n\n /**\n * Creates a new `KVStore` bound to the given namespace.\n *\n * @param namespace The object store name backing the instance.\n */\n constructor(namespace: string) {\n isKey(namespace, 'namespace')\n this.namespace = namespace\n this.ready = assertStore(namespace)\n }\n\n /**\n * Returns the value associated with the given key.\n *\n * @param key The key to look up.\n * @returns A promise that fulfills with the stored value, if any.\n */\n async get(key: string): Promise<T | undefined> {\n isKey(key, 'key')\n await this.ready\n const db = await resolveDB()\n\n const row = await new Promise<Row<T> | undefined>((resolve, reject) => {\n try {\n const tx = db.transaction(this.namespace, 'readonly')\n const store = tx.objectStore(this.namespace)\n const request = store.get(key)\n\n tx.oncomplete = () => resolve(request.result)\n tx.onerror = () =>\n reject(\n new KVStoreError('INDEXED_DB_TRANSACTION_FAILED', tx.error?.message)\n )\n tx.onabort = () =>\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_ABORTED',\n tx.error?.message\n )\n )\n } catch (error) {\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_FAILED',\n error instanceof Error ? error.message : undefined\n )\n )\n }\n })\n\n return row?.value ?? undefined\n }\n\n /**\n * Returns whether the given key exists.\n *\n * @param key The key to look up.\n * @returns A promise that fulfills with `true` if the key exists.\n */\n async has(key: string): Promise<boolean> {\n isKey(key, 'key')\n await this.ready\n const db = await resolveDB()\n\n return new Promise<boolean>((resolve, reject) => {\n try {\n const tx = db.transaction(this.namespace, 'readonly')\n const store = tx.objectStore(this.namespace)\n const request =\n typeof store.getKey === 'function'\n ? store.getKey(key)\n : store.get(key)\n\n tx.oncomplete = () => resolve(request.result !== undefined)\n tx.onerror = () =>\n reject(\n new KVStoreError('INDEXED_DB_TRANSACTION_FAILED', tx.error?.message)\n )\n tx.onabort = () =>\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_ABORTED',\n tx.error?.message\n )\n )\n } catch (error) {\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_FAILED',\n error instanceof Error ? error.message : undefined\n )\n )\n }\n })\n }\n\n /**\n * Stores a value for the given key.\n *\n * @param key The key to write.\n * @param value The value to associate with `key`.\n * @returns A promise that fulfills when the write completes.\n */\n async put(key: string, value: T): Promise<void> {\n isKey(key, 'key')\n await this.ready\n const db = await resolveDB()\n\n await new Promise<void>((resolve, reject) => {\n try {\n const tx = db.transaction(this.namespace, 'readwrite')\n const store = tx.objectStore(this.namespace)\n const row: Row<T> = { key, value }\n\n store.put(row)\n\n tx.oncomplete = () => resolve()\n tx.onerror = () =>\n reject(\n new KVStoreError('INDEXED_DB_TRANSACTION_FAILED', tx.error?.message)\n )\n tx.onabort = () =>\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_ABORTED',\n tx.error?.message\n )\n )\n } catch (error) {\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_FAILED',\n error instanceof Error ? error.message : undefined\n )\n )\n }\n })\n }\n\n /**\n * Deletes the value associated with the given key.\n *\n * @param key The key to delete.\n * @returns A promise that fulfills when the deletion completes.\n */\n async delete(key: string): Promise<void> {\n isKey(key, 'key')\n await this.ready\n const db = await resolveDB()\n\n await new Promise<void>((resolve, reject) => {\n try {\n const tx = db.transaction(this.namespace, 'readwrite')\n const store = tx.objectStore(this.namespace)\n\n store.delete(key)\n\n tx.oncomplete = () => resolve()\n tx.onerror = () =>\n reject(\n new KVStoreError('INDEXED_DB_TRANSACTION_FAILED', tx.error?.message)\n )\n tx.onabort = () =>\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_ABORTED',\n tx.error?.message\n )\n )\n } catch (error) {\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_FAILED',\n error instanceof Error ? error.message : undefined\n )\n )\n }\n })\n }\n\n /**\n * Deletes every value stored in the namespace.\n *\n * @returns A promise that fulfills when the namespace is cleared.\n */\n async clear(): Promise<void> {\n await this.ready\n const db = await resolveDB()\n\n await new Promise<void>((resolve, reject) => {\n try {\n const tx = db.transaction(this.namespace, 'readwrite')\n const store = tx.objectStore(this.namespace)\n\n store.clear()\n\n tx.oncomplete = () => resolve()\n tx.onerror = () =>\n reject(\n new KVStoreError('INDEXED_DB_TRANSACTION_FAILED', tx.error?.message)\n )\n tx.onabort = () =>\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_ABORTED',\n tx.error?.message\n )\n )\n } catch (error) {\n reject(\n new KVStoreError(\n 'INDEXED_DB_TRANSACTION_FAILED',\n error instanceof Error ? error.message : undefined\n )\n )\n }\n })\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;AAeO,IAAM,eAAN,cAA2B,MAAM;AAAA;AAAA;AAAA;AAAA,EAI7B;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQT,YAAY,MAAwB,SAAkB;AACpD,UAAM,SAAS,WAAW;AAC1B,UAAM,qCAAqC,MAAM,EAAE;AACnD,SAAK,OAAO;AACZ,SAAK,OAAO;AAAA,EACd;AACF;;;ACxBO,SAAS,MAAM,OAAe,OAAqB;AACxD,MAAI,OAAO,UAAU,YAAY,MAAM,UAAU,GAAG;AAClD,UAAM,IAAI;AAAA,MACR;AAAA,MACA,GAAG,KAAK;AAAA,IACV;AAAA,EACF;AACF;;;ACdA,IAAM,UAAU;AAEhB,IAAI,QAA4B;AAChC,IAAI,YAAyC;AAC7C,IAAI,mBAAkC,QAAQ,QAAQ;AAQtD,SAAS,QAAQ,IAA8B;AAC7C,KAAG,kBAAkB,MAAM;AACzB,QAAI,UAAU,IAAI;AAChB,cAAQ;AACR,kBAAY;AAAA,IACd;AAEA,OAAG,MAAM;AAAA,EACX;AAEA,UAAQ;AACR,cAAY,QAAQ,QAAQ,EAAE;AAE9B,SAAO;AACT;AASA,SAAS,OACP,SACA,WACsB;AACtB,SAAO,IAAI,QAAQ,CAAC,SAAS,WAAW;AACtC,UAAM,UACJ,YAAY,SACR,UAAU,KAAK,OAAO,IACtB,UAAU,KAAK,SAAS,OAAO;AAErC,YAAQ,kBAAkB,MAAM;AAC9B,kBAAY,QAAQ,MAAM;AAAA,IAC5B;AAEA,YAAQ,YAAY,MAAM,QAAQ,QAAQ,QAAQ,MAAM,CAAC;AACzD,YAAQ,UAAU,MAChB,OAAO,IAAI,aAAa,wBAAwB,QAAQ,OAAO,OAAO,CAAC;AACzE,YAAQ,YAAY,CAAC,UACnB;AAAA,MACE,IAAI;AAAA,QACF;AAAA,QACA,+BAA+B,OAAO,iBAAiB,MAAM,UAAU,gBAAgB,MAAM,UAAU;AAAA,MACzG;AAAA,IACF;AAAA,EACJ,CAAC;AACH;AAKA,SAAS,UAAgB;AACvB,MAAI,MAAO,OAAM,MAAM;AACvB,UAAQ;AACR,cAAY;AACd;AAOA,eAAsB,YAAkC;AACtD,MAAI,MAAO,QAAO;AAElB,MAAI,CAAC,WAAW;AACd,gBAAY,OAAO,EAAE,MAAM,CAAC,UAAU;AACpC,kBAAY;AACZ,YAAM;AAAA,IACR,CAAC;AAAA,EACH;AAEA,SAAO;AACT;AAOA,eAAsB,YAA2B;AAC/C,UAAQ;AAER,QAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AAC3C,UAAM,UAAU,UAAU,eAAe,OAAO;AAEhD,YAAQ,YAAY,MAAM,QAAQ;AAClC,YAAQ,UAAU,MAChB;AAAA,MACE,IAAI,aAAa,4BAA4B,QAAQ,OAAO,OAAO;AAAA,IACrE;AACF,YAAQ,YAAY,CAAC,UACnB;AAAA,MACE,IAAI;AAAA,QACF;AAAA,QACA,iCAAiC,OAAO,iBAAiB,MAAM,UAAU,gBAAgB,MAAM,UAAU;AAAA,MAC3G;AAAA,IACF;AAAA,EACJ,CAAC;AACH;AAQO,SAAS,YAAY,WAAkC;AAC5D,QAAM,OAAO,iBAAiB,KAAK,YAAY;AAC7C,UAAM,KAAK,MAAM,UAAU;AAE3B,QAAI,GAAG,iBAAiB,SAAS,SAAS,EAAG;AAE7C,UAAM,cAAc,GAAG,UAAU;AACjC,YAAQ;AAER,UAAM,OAAO,aAAa,CAAC,cAAc;AACvC,UAAI,CAAC,UAAU,iBAAiB,SAAS,SAAS,GAAG;AACnD,kBAAU,kBAAkB,WAAW,EAAE,SAAS,MAAM,CAAC;AAAA,MAC3D;AAAA,IACF,CAAC;AAAA,EACH,CAAC;AAED,qBAAmB,KAAK,MAAM,MAAM;AAAA,EAAC,CAAC;AACtC,SAAO;AACT;;;ACnIO,IAAM,UAAN,MAAiD;AAAA;AAAA;AAAA;AAAA,EAItC;AAAA;AAAA;AAAA;AAAA,EAKC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOjB,YAAY,WAAmB;AAC7B,UAAM,WAAW,WAAW;AAC5B,SAAK,YAAY;AACjB,SAAK,QAAQ,YAAY,SAAS;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,KAAqC;AAC7C,UAAM,KAAK,KAAK;AAChB,UAAM,KAAK;AACX,UAAM,KAAK,MAAM,UAAU;AAE3B,UAAM,MAAM,MAAM,IAAI,QAA4B,CAAC,SAAS,WAAW;AACrE,UAAI;AACF,cAAM,KAAK,GAAG,YAAY,KAAK,WAAW,UAAU;AACpD,cAAM,QAAQ,GAAG,YAAY,KAAK,SAAS;AAC3C,cAAM,UAAU,MAAM,IAAI,GAAG;AAE7B,WAAG,aAAa,MAAM,QAAQ,QAAQ,MAAM;AAC5C,WAAG,UAAU,MACX;AAAA,UACE,IAAI,aAAa,iCAAiC,GAAG,OAAO,OAAO;AAAA,QACrE;AACF,WAAG,UAAU,MACX;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,GAAG,OAAO;AAAA,UACZ;AAAA,QACF;AAAA,MACJ,SAAS,OAAO;AACd;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,iBAAiB,QAAQ,MAAM,UAAU;AAAA,UAC3C;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAED,WAAO,KAAK,SAAS;AAAA,EACvB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,IAAI,KAA+B;AACvC,UAAM,KAAK,KAAK;AAChB,UAAM,KAAK;AACX,UAAM,KAAK,MAAM,UAAU;AAE3B,WAAO,IAAI,QAAiB,CAAC,SAAS,WAAW;AAC/C,UAAI;AACF,cAAM,KAAK,GAAG,YAAY,KAAK,WAAW,UAAU;AACpD,cAAM,QAAQ,GAAG,YAAY,KAAK,SAAS;AAC3C,cAAM,UACJ,OAAO,MAAM,WAAW,aACpB,MAAM,OAAO,GAAG,IAChB,MAAM,IAAI,GAAG;AAEnB,WAAG,aAAa,MAAM,QAAQ,QAAQ,WAAW,MAAS;AAC1D,WAAG,UAAU,MACX;AAAA,UACE,IAAI,aAAa,iCAAiC,GAAG,OAAO,OAAO;AAAA,QACrE;AACF,WAAG,UAAU,MACX;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,GAAG,OAAO;AAAA,UACZ;AAAA,QACF;AAAA,MACJ,SAAS,OAAO;AACd;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,iBAAiB,QAAQ,MAAM,UAAU;AAAA,UAC3C;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,IAAI,KAAa,OAAyB;AAC9C,UAAM,KAAK,KAAK;AAChB,UAAM,KAAK;AACX,UAAM,KAAK,MAAM,UAAU;AAE3B,UAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AAC3C,UAAI;AACF,cAAM,KAAK,GAAG,YAAY,KAAK,WAAW,WAAW;AACrD,cAAM,QAAQ,GAAG,YAAY,KAAK,SAAS;AAC3C,cAAM,MAAc,EAAE,KAAK,MAAM;AAEjC,cAAM,IAAI,GAAG;AAEb,WAAG,aAAa,MAAM,QAAQ;AAC9B,WAAG,UAAU,MACX;AAAA,UACE,IAAI,aAAa,iCAAiC,GAAG,OAAO,OAAO;AAAA,QACrE;AACF,WAAG,UAAU,MACX;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,GAAG,OAAO;AAAA,UACZ;AAAA,QACF;AAAA,MACJ,SAAS,OAAO;AACd;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,iBAAiB,QAAQ,MAAM,UAAU;AAAA,UAC3C;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,OAAO,KAA4B;AACvC,UAAM,KAAK,KAAK;AAChB,UAAM,KAAK;AACX,UAAM,KAAK,MAAM,UAAU;AAE3B,UAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AAC3C,UAAI;AACF,cAAM,KAAK,GAAG,YAAY,KAAK,WAAW,WAAW;AACrD,cAAM,QAAQ,GAAG,YAAY,KAAK,SAAS;AAE3C,cAAM,OAAO,GAAG;AAEhB,WAAG,aAAa,MAAM,QAAQ;AAC9B,WAAG,UAAU,MACX;AAAA,UACE,IAAI,aAAa,iCAAiC,GAAG,OAAO,OAAO;AAAA,QACrE;AACF,WAAG,UAAU,MACX;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,GAAG,OAAO;AAAA,UACZ;AAAA,QACF;AAAA,MACJ,SAAS,OAAO;AACd;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,iBAAiB,QAAQ,MAAM,UAAU;AAAA,UAC3C;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAM,QAAuB;AAC3B,UAAM,KAAK;AACX,UAAM,KAAK,MAAM,UAAU;AAE3B,UAAM,IAAI,QAAc,CAAC,SAAS,WAAW;AAC3C,UAAI;AACF,cAAM,KAAK,GAAG,YAAY,KAAK,WAAW,WAAW;AACrD,cAAM,QAAQ,GAAG,YAAY,KAAK,SAAS;AAE3C,cAAM,MAAM;AAEZ,WAAG,aAAa,MAAM,QAAQ;AAC9B,WAAG,UAAU,MACX;AAAA,UACE,IAAI,aAAa,iCAAiC,GAAG,OAAO,OAAO;AAAA,QACrE;AACF,WAAG,UAAU,MACX;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,GAAG,OAAO;AAAA,UACZ;AAAA,QACF;AAAA,MACJ,SAAS,OAAO;AACd;AAAA,UACE,IAAI;AAAA,YACF;AAAA,YACA,iBAAiB,QAAQ,MAAM,UAAU;AAAA,UAC3C;AAAA,QACF;AAAA,MACF;AAAA,IACF,CAAC;AAAA,EACH;AACF;","names":[]}
package/package.json ADDED
@@ -0,0 +1,87 @@
1
+ {
2
+ "type": "module",
3
+ "license": "Apache-2.0",
4
+ "name": "@sovereignbase/offline-kv-store",
5
+ "version": "0.0.0",
6
+ "description": "Namespace-scoped key-value storage on top of IndexedDB with explicit error codes.",
7
+ "keywords": [
8
+ "indexeddb",
9
+ "kv-store",
10
+ "key-value",
11
+ "offline",
12
+ "browser-storage",
13
+ "local-first",
14
+ "typescript",
15
+ "sovereignbase"
16
+ ],
17
+ "main": "./dist/index.cjs",
18
+ "module": "./dist/index.js",
19
+ "types": "./dist/index.d.ts",
20
+ "exports": {
21
+ ".": {
22
+ "types": "./dist/index.d.ts",
23
+ "import": "./dist/index.js",
24
+ "require": "./dist/index.cjs",
25
+ "default": "./dist/index.js"
26
+ },
27
+ "./package.json": "./package.json"
28
+ },
29
+ "engines": {
30
+ "node": ">=20"
31
+ },
32
+ "files": [
33
+ "dist",
34
+ "LICENSE",
35
+ "README.md"
36
+ ],
37
+ "sideEffects": false,
38
+ "scripts": {
39
+ "format": "prettier . --write",
40
+ "build": "tsup",
41
+ "test": "npm run build && node test/run-coverage.mjs && node test/e2e/run.mjs",
42
+ "bench": "npm run build && node benchmark/bench.js",
43
+ "prepare": "husky",
44
+ "prepublishOnly": "npm run test && npm run bench"
45
+ },
46
+ "c8": {
47
+ "all": true,
48
+ "include": [
49
+ "dist/**/*.js"
50
+ ],
51
+ "exclude": [
52
+ "dist/**/*.d.ts",
53
+ "test/**",
54
+ "benchmark/**",
55
+ "playwright.config.ts"
56
+ ]
57
+ },
58
+ "devDependencies": {
59
+ "@commitlint/cli": "^20.5.0",
60
+ "@commitlint/config-conventional": "^20.5.0",
61
+ "@playwright/test": "^1.59.1",
62
+ "@types/node": "^25.5.2",
63
+ "c8": "^11.0.0",
64
+ "edge-runtime": "^4.0.1",
65
+ "fake-indexeddb": "^6.2.5",
66
+ "fast-glob": "^3.3.3",
67
+ "husky": "^9.1.7",
68
+ "playwright": "^1.59.1",
69
+ "prettier": "^3.8.1",
70
+ "tsup": "^8.5.1",
71
+ "typescript": "^5.9.3",
72
+ "wrangler": "^4.79.0"
73
+ },
74
+ "dependencies": {
75
+ "@sovereignbase/bytecodec": "^1.5.1",
76
+ "@sovereignbase/cryptosuite": "^2.0.5",
77
+ "@sovereignbase/observed-remove-set": "^1.0.1"
78
+ },
79
+ "repository": {
80
+ "type": "git",
81
+ "url": "git+https://github.com/sovereignbase/offline-kv-store.git"
82
+ },
83
+ "bugs": {
84
+ "url": "https://github.com/sovereignbase/offline-kv-store/issues"
85
+ },
86
+ "homepage": "https://github.com/sovereignbase/offline-kv-store#readme"
87
+ }