@sv443-network/coreutils 2.0.3 → 3.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.
- package/CHANGELOG.md +32 -0
- package/README.md +4 -3
- package/dist/CoreUtils.cjs +168 -103
- package/dist/CoreUtils.min.cjs +5 -3
- package/dist/CoreUtils.min.mjs +5 -3
- package/dist/CoreUtils.min.umd.js +5 -3
- package/dist/CoreUtils.mjs +168 -103
- package/dist/CoreUtils.umd.js +174 -107
- package/dist/lib/DataStore.d.ts +21 -7
- package/dist/lib/DataStoreEngine.d.ts +8 -8
- package/dist/lib/DataStoreSerializer.d.ts +2 -0
- package/dist/lib/Errors.d.ts +15 -3
- package/dist/lib/NanoEmitter.d.ts +6 -5
- package/dist/lib/math.d.ts +1 -1
- package/dist/lib/misc.d.ts +6 -0
- package/dist/lib/{TestDataStore.d.ts → test/DirectAccessDataStore.d.ts} +4 -3
- package/dist/lib/test/softExpect.d.ts +11 -0
- package/dist/lib/types.d.ts +7 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,37 @@
|
|
|
1
1
|
# @sv443-network/coreutils
|
|
2
2
|
|
|
3
|
+
## 3.0.0
|
|
4
|
+
|
|
5
|
+
### Major Changes
|
|
6
|
+
|
|
7
|
+
- 7718855: **Changed `DataStoreEngine` instances to allow storing original values instead of only strings.**
|
|
8
|
+
|
|
9
|
+
The previous behavior of explicit serialization was prone to errors and made it hard to implement certain features, such as data migration from UserUtils.
|
|
10
|
+
If you have created a custom `DataStoreEngine`, please ensure it supports storing and retrieving all values supported by JSON, i.e. `string`, `number`, `boolean`, `null`, `object` and `array`. Values like `undefined`, `Symbol`, `Function` etc. are still not supported and will lead to errors.
|
|
11
|
+
|
|
12
|
+
- 46570f4: **`NanoEmitter` multi methods' `oneOf` and `allOf` properties now behave like an AND condition instead of an OR.**
|
|
13
|
+
|
|
14
|
+
### Minor Changes
|
|
15
|
+
|
|
16
|
+
- 1124d2e: Added DataStoreSerializer property `remapIds` to support deserializing from stores with outdated IDs.
|
|
17
|
+
- 240f83e: Added DataStore prop `memoryCache` to turn off the memory cache in data-intensive, non-latency-sensitive scenarios.
|
|
18
|
+
- 7718855: Made DataStore able to migrate data from [UserUtils <=v9 DataStore](https://github.com/Sv443-Network/UserUtils/blob/v9.4.4/docs.md#datastore) instances.
|
|
19
|
+
|
|
20
|
+
In order to trigger the migration:
|
|
21
|
+
|
|
22
|
+
1. Switch the DataStore import from UserUtils to CoreUtils and keep the same DataStore ID.
|
|
23
|
+
2. Update the options object in the DataStore constructor. (You may also want to refer to the [new DataStore documentation](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-datastore).)
|
|
24
|
+
- The constructor now needs an `engine` property that is an instance of a [UserUtils `GMStorageEngine`.](https://github.com/Sv443-Network/UserUtils/blob/main/docs.md#class-gmstorageengine)
|
|
25
|
+
- Encoding with `deflate-raw` will now be enabled by default. Set `compressionFormat: null` to disable compression if it wasn't enabled in the UserUtils DataStore.
|
|
26
|
+
- Added shorthand property `compressionFormat` as an alternative to the properties `encodeData` and `decodeData`
|
|
27
|
+
- `encodeData` and `decodeData` are now a tuple array, consisting of a format identifier string and the function which was previously the only value of these properties.
|
|
28
|
+
3. The next call to `loadData()` will then migrate the data automatically and transparently.
|
|
29
|
+
|
|
30
|
+
### Patch Changes
|
|
31
|
+
|
|
32
|
+
- 99a797f: `secsToTimeStr()` now supports negative time and will only throw if the number is `NaN` or not finite.
|
|
33
|
+
- 38e7813: Implemented `DatedError`, `CustomError` and new classes `ScriptContextError` and `NetworkError` throughout the library.
|
|
34
|
+
|
|
3
35
|
## 2.0.3
|
|
4
36
|
|
|
5
37
|
### Patch Changes
|
package/README.md
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
<div align="center" style="text-align: center;">
|
|
2
2
|
|
|
3
3
|
# CoreUtils
|
|
4
|
-
Cross-platform, general-purpose, JavaScript core library for Node, Deno and the browser.
|
|
4
|
+
Cross-platform, general-purpose, JavaScript core library for Node, Deno and the browser with tons of various utility functions and classes.
|
|
5
5
|
Intended to be used in conjunction with [`@sv443-network/userutils`](https://github.com/Sv443-Network/UserUtils) and [`@sv443-network/djsutils`](https://github.com/Sv443-Network/DJSUtils), but can be used independently as well.
|
|
6
6
|
|
|
7
7
|
### [Documentation](./docs.md#readme) • [Features](#features) • [Installation](#installation) • [License](./LICENSE.txt) • [Changelog](./CHANGELOG.md)
|
|
@@ -56,6 +56,7 @@ Intended to be used in conjunction with [`@sv443-network/userutils`](https://git
|
|
|
56
56
|
- [**Errors:**](./docs.md#errors)
|
|
57
57
|
- 🟧 [`class DatedError`](./docs.md#class-datederror) - Base error class with a `date` property
|
|
58
58
|
- 🟧 [`class ChecksumMismatchError`](./docs.md#class-checksummismatcherror) - Error thrown when two checksums don't match
|
|
59
|
+
- 🟧 [`class CustomError`](./docs.md#class-customerror) - Custom error with a configurable name for one-off situations
|
|
59
60
|
- 🟧 [`class MigrationError`](./docs.md#class-migrationerror) - Error thrown in a failed data migration
|
|
60
61
|
- 🟧 [`class ValidationError`](./docs.md#class-validationerror) - Error while validating data
|
|
61
62
|
- [**Math:**](./docs.md#math)
|
|
@@ -90,7 +91,7 @@ Intended to be used in conjunction with [`@sv443-network/userutils`](https://git
|
|
|
90
91
|
- 🟣 [`function autoPlural()`](./docs.md#function-autoplural) - Turns the given term into its plural form, depending on the given number or list length
|
|
91
92
|
- 🟣 [`function capitalize()`](./docs.md#function-capitalize) - Capitalizes the first letter of the given string
|
|
92
93
|
- 🟣 [`function createProgressBar()`](./docs.md#function-createprogressbar) - Creates a progress bar string with the given percentage and length
|
|
93
|
-
-
|
|
94
|
+
- ⬜ [`const defaultPbChars`](./docs.md#const-defaultpbchars) - Default characters for the progress bar
|
|
94
95
|
- 🔷 [`type ProgressBarChars`](./docs.md#type-progressbarchars) - Type for the progress bar characters object
|
|
95
96
|
- 🟣 [`function joinArrayReadable()`](./docs.md#function-joinarrayreadable) - Joins the given array into a string, using the given separators and last separator
|
|
96
97
|
- 🟣 [`function secsToTimeStr()`](./docs.md#function-secstotimestr) - Turns the given number of seconds into a string in the format `(hh:)mm:ss` with intelligent zero-padding
|
|
@@ -125,7 +126,7 @@ Intended to be used in conjunction with [`@sv443-network/userutils`](https://git
|
|
|
125
126
|
> 🟣 = function
|
|
126
127
|
> 🟧 = class
|
|
127
128
|
> 🔷 = type
|
|
128
|
-
>
|
|
129
|
+
> ⬜ = const
|
|
129
130
|
|
|
130
131
|
<br>
|
|
131
132
|
|
package/dist/CoreUtils.cjs
CHANGED
|
@@ -32,6 +32,7 @@ var lib_exports = {};
|
|
|
32
32
|
__export(lib_exports, {
|
|
33
33
|
BrowserStorageEngine: () => BrowserStorageEngine,
|
|
34
34
|
ChecksumMismatchError: () => ChecksumMismatchError,
|
|
35
|
+
CustomError: () => CustomError,
|
|
35
36
|
DataStore: () => DataStore,
|
|
36
37
|
DataStoreEngine: () => DataStoreEngine,
|
|
37
38
|
DataStoreSerializer: () => DataStoreSerializer,
|
|
@@ -40,6 +41,8 @@ __export(lib_exports, {
|
|
|
40
41
|
FileStorageEngine: () => FileStorageEngine,
|
|
41
42
|
MigrationError: () => MigrationError,
|
|
42
43
|
NanoEmitter: () => NanoEmitter,
|
|
44
|
+
NetworkError: () => NetworkError,
|
|
45
|
+
ScriptContextError: () => ScriptContextError,
|
|
43
46
|
ValidationError: () => ValidationError,
|
|
44
47
|
abtoa: () => abtoa,
|
|
45
48
|
atoab: () => atoab,
|
|
@@ -59,6 +62,7 @@ __export(lib_exports, {
|
|
|
59
62
|
digitCount: () => digitCount,
|
|
60
63
|
fetchAdvanced: () => fetchAdvanced,
|
|
61
64
|
formatNumber: () => formatNumber,
|
|
65
|
+
getCallStack: () => getCallStack,
|
|
62
66
|
getListLength: () => getListLength,
|
|
63
67
|
hexToRgb: () => hexToRgb,
|
|
64
68
|
insertValues: () => insertValues,
|
|
@@ -175,7 +179,7 @@ function roundFixed(num, fractionDigits) {
|
|
|
175
179
|
const scale = 10 ** fractionDigits;
|
|
176
180
|
return Math.round(num * scale) / scale;
|
|
177
181
|
}
|
|
178
|
-
function valsWithin(a, b, dec =
|
|
182
|
+
function valsWithin(a, b, dec = 1, withinRange = 0.5) {
|
|
179
183
|
return Math.abs(roundFixed(a, dec) - roundFixed(b, dec)) <= withinRange;
|
|
180
184
|
}
|
|
181
185
|
|
|
@@ -325,6 +329,52 @@ function randomId(length = 16, radix = 16, enhancedEntropy = false, randomCase =
|
|
|
325
329
|
return arr.map((v) => caseArr[randRange(0, caseArr.length - 1, enhancedEntropy)] === 1 ? v.toUpperCase() : v).join("");
|
|
326
330
|
}
|
|
327
331
|
|
|
332
|
+
// lib/Errors.ts
|
|
333
|
+
var DatedError = class extends Error {
|
|
334
|
+
date;
|
|
335
|
+
constructor(message, options) {
|
|
336
|
+
super(message, options);
|
|
337
|
+
this.name = this.constructor.name;
|
|
338
|
+
this.date = /* @__PURE__ */ new Date();
|
|
339
|
+
}
|
|
340
|
+
};
|
|
341
|
+
var ChecksumMismatchError = class extends DatedError {
|
|
342
|
+
constructor(message, options) {
|
|
343
|
+
super(message, options);
|
|
344
|
+
this.name = "ChecksumMismatchError";
|
|
345
|
+
}
|
|
346
|
+
};
|
|
347
|
+
var CustomError = class extends DatedError {
|
|
348
|
+
constructor(name, message, options) {
|
|
349
|
+
super(message, options);
|
|
350
|
+
this.name = name;
|
|
351
|
+
}
|
|
352
|
+
};
|
|
353
|
+
var MigrationError = class extends DatedError {
|
|
354
|
+
constructor(message, options) {
|
|
355
|
+
super(message, options);
|
|
356
|
+
this.name = "MigrationError";
|
|
357
|
+
}
|
|
358
|
+
};
|
|
359
|
+
var ValidationError = class extends DatedError {
|
|
360
|
+
constructor(message, options) {
|
|
361
|
+
super(message, options);
|
|
362
|
+
this.name = "ValidationError";
|
|
363
|
+
}
|
|
364
|
+
};
|
|
365
|
+
var ScriptContextError = class extends DatedError {
|
|
366
|
+
constructor(message, options) {
|
|
367
|
+
super(message, options);
|
|
368
|
+
this.name = "ScriptContextError";
|
|
369
|
+
}
|
|
370
|
+
};
|
|
371
|
+
var NetworkError = class extends DatedError {
|
|
372
|
+
constructor(message, options) {
|
|
373
|
+
super(message, options);
|
|
374
|
+
this.name = "NetworkError";
|
|
375
|
+
}
|
|
376
|
+
};
|
|
377
|
+
|
|
328
378
|
// lib/misc.ts
|
|
329
379
|
async function consumeGen(valGen) {
|
|
330
380
|
return await (typeof valGen === "function" ? valGen() : valGen);
|
|
@@ -353,7 +403,7 @@ async function fetchAdvanced(input, options = {}) {
|
|
|
353
403
|
return res;
|
|
354
404
|
} catch (err) {
|
|
355
405
|
typeof id !== "undefined" && clearTimeout(id);
|
|
356
|
-
throw new
|
|
406
|
+
throw new NetworkError("Error while calling fetch", { cause: err });
|
|
357
407
|
}
|
|
358
408
|
}
|
|
359
409
|
function getListLength(listLike, zeroOnInvalid = true) {
|
|
@@ -364,7 +414,7 @@ function pauseFor(time, signal, rejectOnAbort = false) {
|
|
|
364
414
|
const timeout = setTimeout(() => res(), time);
|
|
365
415
|
signal == null ? void 0 : signal.addEventListener("abort", () => {
|
|
366
416
|
clearTimeout(timeout);
|
|
367
|
-
rejectOnAbort ? rej(new
|
|
417
|
+
rejectOnAbort ? rej(new CustomError("AbortError", "The pause was aborted")) : res();
|
|
368
418
|
});
|
|
369
419
|
});
|
|
370
420
|
}
|
|
@@ -399,14 +449,24 @@ function scheduleExit(code = 0, timeout = 0) {
|
|
|
399
449
|
if (timeout < 0)
|
|
400
450
|
throw new TypeError("Timeout must be a non-negative number");
|
|
401
451
|
let exit;
|
|
402
|
-
if (typeof process !== "undefined" && "exit" in process)
|
|
452
|
+
if (typeof process !== "undefined" && "exit" in process && typeof process.exit === "function")
|
|
403
453
|
exit = () => process.exit(code);
|
|
404
|
-
else if (typeof Deno !== "undefined" && "exit" in Deno)
|
|
454
|
+
else if (typeof Deno !== "undefined" && "exit" in Deno && typeof Deno.exit === "function")
|
|
405
455
|
exit = () => Deno.exit(code);
|
|
406
456
|
else
|
|
407
|
-
throw new
|
|
457
|
+
throw new ScriptContextError("Cannot exit the process, no exit method available");
|
|
408
458
|
setTimeout(exit, timeout);
|
|
409
459
|
}
|
|
460
|
+
function getCallStack(asArray, lines = Infinity) {
|
|
461
|
+
if (typeof lines !== "number" || isNaN(lines) || lines < 0)
|
|
462
|
+
throw new TypeError("lines parameter must be a non-negative number");
|
|
463
|
+
try {
|
|
464
|
+
throw new Error("This is to capture a stack trace with CoreUtils.getCallStack(). (If you see this somewhere, you can safely ignore it.)");
|
|
465
|
+
} catch (err) {
|
|
466
|
+
const stack = (err.stack ?? "").split("\n").map((line) => line.trim()).slice(2, lines + 2);
|
|
467
|
+
return asArray !== false ? stack : stack.join("\n");
|
|
468
|
+
}
|
|
469
|
+
}
|
|
410
470
|
|
|
411
471
|
// lib/text.ts
|
|
412
472
|
function autoPlural(term, num, pluralType = "auto") {
|
|
@@ -476,16 +536,18 @@ function joinArrayReadable(array, separators = ", ", lastSeparator = " and ") {
|
|
|
476
536
|
return arr.join(separators) + lastItm;
|
|
477
537
|
}
|
|
478
538
|
function secsToTimeStr(seconds) {
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
const
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
539
|
+
const isNegative = seconds < 0;
|
|
540
|
+
const s = Math.abs(seconds);
|
|
541
|
+
if (isNaN(s) || !isFinite(s))
|
|
542
|
+
throw new TypeError("The seconds argument must be a valid number");
|
|
543
|
+
const hrs = Math.floor(s / 3600);
|
|
544
|
+
const mins = Math.floor(s % 3600 / 60);
|
|
545
|
+
const secs = Math.floor(s % 60);
|
|
546
|
+
return (isNegative ? "-" : "") + [
|
|
547
|
+
hrs ? hrs + ":" : "",
|
|
548
|
+
String(mins).padStart(mins > 0 || hrs > 0 ? 2 : 1, "0"),
|
|
487
549
|
":",
|
|
488
|
-
String(secs).padStart(secs > 0 ||
|
|
550
|
+
String(secs).padStart(secs > 0 || mins > 0 || hrs > 0 || seconds === 0 ? 2 : 1, "0")
|
|
489
551
|
].join("");
|
|
490
552
|
}
|
|
491
553
|
function truncStr(input, length, endStr = "...") {
|
|
@@ -494,34 +556,6 @@ function truncStr(input, length, endStr = "...") {
|
|
|
494
556
|
return finalStr.length > length ? finalStr.substring(0, length) : finalStr;
|
|
495
557
|
}
|
|
496
558
|
|
|
497
|
-
// lib/Errors.ts
|
|
498
|
-
var DatedError = class extends Error {
|
|
499
|
-
date;
|
|
500
|
-
constructor(message, options) {
|
|
501
|
-
super(message, options);
|
|
502
|
-
this.name = this.constructor.name;
|
|
503
|
-
this.date = /* @__PURE__ */ new Date();
|
|
504
|
-
}
|
|
505
|
-
};
|
|
506
|
-
var ChecksumMismatchError = class extends DatedError {
|
|
507
|
-
constructor(message, options) {
|
|
508
|
-
super(message, options);
|
|
509
|
-
this.name = "ChecksumMismatchError";
|
|
510
|
-
}
|
|
511
|
-
};
|
|
512
|
-
var MigrationError = class extends DatedError {
|
|
513
|
-
constructor(message, options) {
|
|
514
|
-
super(message, options);
|
|
515
|
-
this.name = "MigrationError";
|
|
516
|
-
}
|
|
517
|
-
};
|
|
518
|
-
var ValidationError = class extends DatedError {
|
|
519
|
-
constructor(message, options) {
|
|
520
|
-
super(message, options);
|
|
521
|
-
this.name = "ValidationError";
|
|
522
|
-
}
|
|
523
|
-
};
|
|
524
|
-
|
|
525
559
|
// lib/DataStore.ts
|
|
526
560
|
var dsFmtVer = 1;
|
|
527
561
|
var DataStore = class {
|
|
@@ -531,6 +565,7 @@ var DataStore = class {
|
|
|
531
565
|
encodeData;
|
|
532
566
|
decodeData;
|
|
533
567
|
compressionFormat = "deflate-raw";
|
|
568
|
+
memoryCache = true;
|
|
534
569
|
engine;
|
|
535
570
|
options;
|
|
536
571
|
/**
|
|
@@ -543,6 +578,7 @@ var DataStore = class {
|
|
|
543
578
|
cachedData;
|
|
544
579
|
migrations;
|
|
545
580
|
migrateIds = [];
|
|
581
|
+
//#region constructor
|
|
546
582
|
/**
|
|
547
583
|
* Creates an instance of DataStore to manage a sync & async database that is cached in memory and persistently saved across sessions.
|
|
548
584
|
* Supports migrating data from older versions to newer ones and populating the cache with default data if no persistent data is found.
|
|
@@ -557,7 +593,8 @@ var DataStore = class {
|
|
|
557
593
|
this.id = opts.id;
|
|
558
594
|
this.formatVersion = opts.formatVersion;
|
|
559
595
|
this.defaultData = opts.defaultData;
|
|
560
|
-
this.
|
|
596
|
+
this.memoryCache = Boolean(opts.memoryCache ?? true);
|
|
597
|
+
this.cachedData = this.memoryCache ? opts.defaultData : {};
|
|
561
598
|
this.migrations = opts.migrations;
|
|
562
599
|
if (opts.migrateIds)
|
|
563
600
|
this.migrateIds = Array.isArray(opts.migrateIds) ? opts.migrateIds : [opts.migrateIds];
|
|
@@ -582,7 +619,7 @@ var DataStore = class {
|
|
|
582
619
|
throw new TypeError("Either `compressionFormat` or `encodeData` and `decodeData` have to be set and valid, but not all three at a time. Please refer to the documentation for more info.");
|
|
583
620
|
this.engine.setDataStoreOptions(opts);
|
|
584
621
|
}
|
|
585
|
-
//#region
|
|
622
|
+
//#region loadData
|
|
586
623
|
/**
|
|
587
624
|
* Loads the data saved in persistent storage into the in-memory cache and also returns a copy of it.
|
|
588
625
|
* Automatically populates persistent storage with default data if it doesn't contain any data yet.
|
|
@@ -593,28 +630,28 @@ var DataStore = class {
|
|
|
593
630
|
if (this.firstInit) {
|
|
594
631
|
this.firstInit = false;
|
|
595
632
|
const dsVer = Number(await this.engine.getValue("__ds_fmt_ver", 0));
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
promises.push(this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat));
|
|
614
|
-
await Promise.allSettled(promises);
|
|
633
|
+
const oldData = await this.engine.getValue(`_uucfg-${this.id}`, null);
|
|
634
|
+
if (oldData) {
|
|
635
|
+
const oldVer = Number(await this.engine.getValue(`_uucfgver-${this.id}`, NaN));
|
|
636
|
+
const oldEnc = await this.engine.getValue(`_uucfgenc-${this.id}`, null);
|
|
637
|
+
const promises = [];
|
|
638
|
+
const migrateFmt = (oldKey, newKey, value) => {
|
|
639
|
+
promises.push(this.engine.setValue(newKey, value));
|
|
640
|
+
promises.push(this.engine.deleteValue(oldKey));
|
|
641
|
+
};
|
|
642
|
+
migrateFmt(`_uucfg-${this.id}`, `__ds-${this.id}-dat`, oldData);
|
|
643
|
+
if (!isNaN(oldVer))
|
|
644
|
+
migrateFmt(`_uucfgver-${this.id}`, `__ds-${this.id}-ver`, oldVer);
|
|
645
|
+
if (typeof oldEnc === "boolean")
|
|
646
|
+
migrateFmt(`_uucfgenc-${this.id}`, `__ds-${this.id}-enf`, oldEnc === true ? this.compressionFormat ?? null : null);
|
|
647
|
+
else {
|
|
648
|
+
promises.push(this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat));
|
|
649
|
+
promises.push(this.engine.deleteValue(`_uucfgenc-${this.id}`));
|
|
615
650
|
}
|
|
616
|
-
await
|
|
651
|
+
await Promise.allSettled(promises);
|
|
617
652
|
}
|
|
653
|
+
if (isNaN(dsVer) || dsVer < dsFmtVer)
|
|
654
|
+
await this.engine.setValue("__ds_fmt_ver", dsFmtVer);
|
|
618
655
|
}
|
|
619
656
|
if (this.migrateIds.length > 0) {
|
|
620
657
|
await this.migrateId(this.migrateIds);
|
|
@@ -624,7 +661,7 @@ var DataStore = class {
|
|
|
624
661
|
let storedFmtVer = Number(await this.engine.getValue(`__ds-${this.id}-ver`, NaN));
|
|
625
662
|
if (typeof storedDataRaw !== "string") {
|
|
626
663
|
await this.saveDefaultData();
|
|
627
|
-
return
|
|
664
|
+
return this.engine.deepCopy(this.defaultData);
|
|
628
665
|
}
|
|
629
666
|
const storedData = storedDataRaw ?? JSON.stringify(this.defaultData);
|
|
630
667
|
const encodingFmt = String(await this.engine.getValue(`__ds-${this.id}-enf`, null));
|
|
@@ -639,23 +676,32 @@ var DataStore = class {
|
|
|
639
676
|
parsed = await this.runMigrations(parsed, storedFmtVer);
|
|
640
677
|
if (saveData)
|
|
641
678
|
await this.setData(parsed);
|
|
642
|
-
|
|
679
|
+
if (this.memoryCache)
|
|
680
|
+
return this.cachedData = this.engine.deepCopy(parsed);
|
|
681
|
+
else
|
|
682
|
+
return this.engine.deepCopy(parsed);
|
|
643
683
|
} catch (err) {
|
|
644
684
|
console.warn("Error while parsing JSON data, resetting it to the default value.", err);
|
|
645
685
|
await this.saveDefaultData();
|
|
646
686
|
return this.defaultData;
|
|
647
687
|
}
|
|
648
688
|
}
|
|
689
|
+
//#region getData
|
|
649
690
|
/**
|
|
650
691
|
* Returns a copy of the data from the in-memory cache.
|
|
651
|
-
* Use {@linkcode loadData()} to get fresh data from persistent storage (usually not necessary since the cache should always exactly reflect persistent storage).
|
|
692
|
+
* Use {@linkcode loadData()} to get fresh data from persistent storage (usually not necessary since the cache should always exactly reflect persistent storage).
|
|
693
|
+
* ⚠️ If `memoryCache` was set to `false` in the constructor options, this method will throw an error.
|
|
652
694
|
*/
|
|
653
695
|
getData() {
|
|
696
|
+
if (!this.memoryCache)
|
|
697
|
+
throw new DatedError("In-memory cache is disabled for this DataStore instance, so getData() can't be used. Please use loadData() instead.");
|
|
654
698
|
return this.engine.deepCopy(this.cachedData);
|
|
655
699
|
}
|
|
700
|
+
//#region setData
|
|
656
701
|
/** Saves the data synchronously to the in-memory cache and asynchronously to the persistent storage */
|
|
657
702
|
setData(data) {
|
|
658
|
-
this.
|
|
703
|
+
if (this.memoryCache)
|
|
704
|
+
this.cachedData = data;
|
|
659
705
|
return new Promise(async (resolve) => {
|
|
660
706
|
await Promise.allSettled([
|
|
661
707
|
this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(data, this.encodingEnabled())),
|
|
@@ -665,15 +711,18 @@ var DataStore = class {
|
|
|
665
711
|
resolve();
|
|
666
712
|
});
|
|
667
713
|
}
|
|
714
|
+
//#region saveDefaultData
|
|
668
715
|
/** Saves the default data passed in the constructor synchronously to the in-memory cache and asynchronously to persistent storage */
|
|
669
716
|
async saveDefaultData() {
|
|
670
|
-
|
|
717
|
+
if (this.memoryCache)
|
|
718
|
+
this.cachedData = this.defaultData;
|
|
671
719
|
await Promise.allSettled([
|
|
672
720
|
this.engine.setValue(`__ds-${this.id}-dat`, await this.engine.serializeData(this.defaultData, this.encodingEnabled())),
|
|
673
721
|
this.engine.setValue(`__ds-${this.id}-ver`, this.formatVersion),
|
|
674
722
|
this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat)
|
|
675
723
|
]);
|
|
676
724
|
}
|
|
725
|
+
//#region deleteData
|
|
677
726
|
/**
|
|
678
727
|
* Call this method to clear all persistently stored data associated with this DataStore instance, including the storage container (if supported by the DataStoreEngine).
|
|
679
728
|
* The in-memory cache will be left untouched, so you may still access the data with {@linkcode getData()}
|
|
@@ -688,11 +737,12 @@ var DataStore = class {
|
|
|
688
737
|
]);
|
|
689
738
|
await ((_b = (_a = this.engine).deleteStorage) == null ? void 0 : _b.call(_a));
|
|
690
739
|
}
|
|
740
|
+
//#region encodingEnabled
|
|
691
741
|
/** Returns whether encoding and decoding are enabled for this DataStore instance */
|
|
692
742
|
encodingEnabled() {
|
|
693
743
|
return Boolean(this.encodeData && this.decodeData) && this.compressionFormat !== null || Boolean(this.compressionFormat);
|
|
694
744
|
}
|
|
695
|
-
//#region
|
|
745
|
+
//#region runMigrations
|
|
696
746
|
/**
|
|
697
747
|
* Runs all necessary migration functions consecutively and saves the result to the in-memory cache and persistent storage and also returns it.
|
|
698
748
|
* This method is automatically called by {@linkcode loadData()} if the data format has changed since the last time the data was saved.
|
|
@@ -726,8 +776,12 @@ var DataStore = class {
|
|
|
726
776
|
this.engine.setValue(`__ds-${this.id}-ver`, lastFmtVer),
|
|
727
777
|
this.engine.setValue(`__ds-${this.id}-enf`, this.compressionFormat)
|
|
728
778
|
]);
|
|
729
|
-
|
|
779
|
+
if (this.memoryCache)
|
|
780
|
+
return this.cachedData = this.engine.deepCopy(newData);
|
|
781
|
+
else
|
|
782
|
+
return this.engine.deepCopy(newData);
|
|
730
783
|
}
|
|
784
|
+
//#region migrateId
|
|
731
785
|
/**
|
|
732
786
|
* Tries to migrate the currently saved persistent data from one or more old IDs to the ID set in the constructor.
|
|
733
787
|
* If no data exist for the old ID(s), nothing will be done, but some time may still pass trying to fetch the non-existent data.
|
|
@@ -771,7 +825,7 @@ var DataStoreEngine = class {
|
|
|
771
825
|
this.dataStoreOptions = dataStoreOptions;
|
|
772
826
|
}
|
|
773
827
|
//#region serialization api
|
|
774
|
-
/** Serializes the given object to a string, optionally encoded with `options.encodeData` if {@linkcode useEncoding} is set to
|
|
828
|
+
/** Serializes the given object to a string, optionally encoded with `options.encodeData` if {@linkcode useEncoding} is not set to false and the `encodeData` and `decodeData` options are set */
|
|
775
829
|
async serializeData(data, useEncoding) {
|
|
776
830
|
var _a, _b, _c, _d, _e;
|
|
777
831
|
this.ensureDataStoreOptions();
|
|
@@ -819,7 +873,7 @@ var BrowserStorageEngine = class extends DataStoreEngine {
|
|
|
819
873
|
* Creates an instance of `BrowserStorageEngine`.
|
|
820
874
|
*
|
|
821
875
|
* - ⚠️ Requires a DOM environment
|
|
822
|
-
* - ⚠️ Don't reuse
|
|
876
|
+
* - ⚠️ Don't reuse engine instances, always create a new one for each {@linkcode DataStore} instance
|
|
823
877
|
*/
|
|
824
878
|
constructor(options) {
|
|
825
879
|
super(options == null ? void 0 : options.dataStoreOptions);
|
|
@@ -857,7 +911,7 @@ var FileStorageEngine = class extends DataStoreEngine {
|
|
|
857
911
|
* Creates an instance of `FileStorageEngine`.
|
|
858
912
|
*
|
|
859
913
|
* - ⚠️ Requires Node.js or Deno with Node compatibility (v1.31+)
|
|
860
|
-
* - ⚠️ Don't reuse
|
|
914
|
+
* - ⚠️ Don't reuse engine instances, always create a new one for each {@linkcode DataStore} instance
|
|
861
915
|
*/
|
|
862
916
|
constructor(options) {
|
|
863
917
|
super(options == null ? void 0 : options.dataStoreOptions);
|
|
@@ -875,7 +929,7 @@ var FileStorageEngine = class extends DataStoreEngine {
|
|
|
875
929
|
if (!fs)
|
|
876
930
|
fs = (_a = await import("fs/promises")) == null ? void 0 : _a.default;
|
|
877
931
|
if (!fs)
|
|
878
|
-
throw new
|
|
932
|
+
throw new ScriptContextError("FileStorageEngine requires Node.js or Deno with Node compatibility (v1.31+)", { cause: new DatedError("'node:fs/promises' module not available") });
|
|
879
933
|
const path = typeof this.options.filePath === "string" ? this.options.filePath : this.options.filePath(this.dataStoreOptions.id);
|
|
880
934
|
const data = await fs.readFile(path, "utf-8");
|
|
881
935
|
return data ? JSON.parse(await ((_d = (_c = (_b = this.dataStoreOptions) == null ? void 0 : _b.decodeData) == null ? void 0 : _c[1]) == null ? void 0 : _d.call(_c, data)) ?? data) : void 0;
|
|
@@ -891,7 +945,7 @@ var FileStorageEngine = class extends DataStoreEngine {
|
|
|
891
945
|
if (!fs)
|
|
892
946
|
fs = (_a = await import("fs/promises")) == null ? void 0 : _a.default;
|
|
893
947
|
if (!fs)
|
|
894
|
-
throw new
|
|
948
|
+
throw new ScriptContextError("FileStorageEngine requires Node.js or Deno with Node compatibility (v1.31+)", { cause: new DatedError("'node:fs/promises' module not available") });
|
|
895
949
|
const path = typeof this.options.filePath === "string" ? this.options.filePath : this.options.filePath(this.dataStoreOptions.id);
|
|
896
950
|
await fs.mkdir(path.slice(0, path.lastIndexOf(path.includes("/") ? "/" : "\\")), { recursive: true });
|
|
897
951
|
await fs.writeFile(path, await ((_d = (_c = (_b = this.dataStoreOptions) == null ? void 0 : _b.encodeData) == null ? void 0 : _c[1]) == null ? void 0 : _d.call(_c, JSON.stringify(data))) ?? JSON.stringify(data, void 0, 2), "utf-8");
|
|
@@ -950,9 +1004,9 @@ var FileStorageEngine = class extends DataStoreEngine {
|
|
|
950
1004
|
if (!fs)
|
|
951
1005
|
fs = (_a = await import("fs/promises")) == null ? void 0 : _a.default;
|
|
952
1006
|
if (!fs)
|
|
953
|
-
throw new
|
|
1007
|
+
throw new ScriptContextError("FileStorageEngine requires Node.js or Deno with Node compatibility (v1.31+)", { cause: new DatedError("'node:fs/promises' module not available") });
|
|
954
1008
|
const path = typeof this.options.filePath === "string" ? this.options.filePath : this.options.filePath(this.dataStoreOptions.id);
|
|
955
|
-
await fs.unlink(path);
|
|
1009
|
+
return await fs.unlink(path);
|
|
956
1010
|
} catch (err) {
|
|
957
1011
|
console.error("Error deleting file:", err);
|
|
958
1012
|
}
|
|
@@ -965,11 +1019,12 @@ var DataStoreSerializer = class _DataStoreSerializer {
|
|
|
965
1019
|
options;
|
|
966
1020
|
constructor(stores, options = {}) {
|
|
967
1021
|
if (!crypto || !crypto.subtle)
|
|
968
|
-
throw new
|
|
1022
|
+
throw new ScriptContextError("DataStoreSerializer has to run in a secure context (HTTPS) or in another environment that implements the subtleCrypto API!");
|
|
969
1023
|
this.stores = stores;
|
|
970
1024
|
this.options = {
|
|
971
1025
|
addChecksum: true,
|
|
972
1026
|
ensureIntegrity: true,
|
|
1027
|
+
remapIds: {},
|
|
973
1028
|
...options
|
|
974
1029
|
};
|
|
975
1030
|
}
|
|
@@ -986,9 +1041,11 @@ var DataStoreSerializer = class _DataStoreSerializer {
|
|
|
986
1041
|
async serializePartial(stores, useEncoding = true, stringified = true) {
|
|
987
1042
|
var _a;
|
|
988
1043
|
const serData = [];
|
|
989
|
-
|
|
1044
|
+
const filteredStores = this.stores.filter((s) => typeof stores === "function" ? stores(s.id) : stores.includes(s.id));
|
|
1045
|
+
for (const storeInst of filteredStores) {
|
|
990
1046
|
const encoded = Boolean(useEncoding && storeInst.encodingEnabled() && ((_a = storeInst.encodeData) == null ? void 0 : _a[1]));
|
|
991
|
-
const
|
|
1047
|
+
const rawData = storeInst.memoryCache ? storeInst.getData() : await storeInst.loadData();
|
|
1048
|
+
const data = encoded ? await storeInst.encodeData[1](JSON.stringify(rawData)) : JSON.stringify(rawData);
|
|
992
1049
|
serData.push({
|
|
993
1050
|
id: storeInst.id,
|
|
994
1051
|
data,
|
|
@@ -1015,10 +1072,18 @@ var DataStoreSerializer = class _DataStoreSerializer {
|
|
|
1015
1072
|
const deserStores = typeof data === "string" ? JSON.parse(data) : data;
|
|
1016
1073
|
if (!Array.isArray(deserStores) || !deserStores.every(_DataStoreSerializer.isSerializedDataStoreObj))
|
|
1017
1074
|
throw new TypeError("Invalid serialized data format! Expected an array of SerializedDataStore objects.");
|
|
1018
|
-
|
|
1019
|
-
|
|
1075
|
+
const resolveStoreId = (id) => {
|
|
1076
|
+
var _a;
|
|
1077
|
+
return ((_a = Object.entries(this.options.remapIds).find(([, v]) => v.includes(id))) == null ? void 0 : _a[0]) ?? id;
|
|
1078
|
+
};
|
|
1079
|
+
const matchesFilter = (id) => typeof stores === "function" ? stores(id) : stores.includes(id);
|
|
1080
|
+
for (const storeData of deserStores) {
|
|
1081
|
+
const effectiveId = resolveStoreId(storeData.id);
|
|
1082
|
+
if (!matchesFilter(effectiveId))
|
|
1083
|
+
continue;
|
|
1084
|
+
const storeInst = this.stores.find((s) => s.id === effectiveId);
|
|
1020
1085
|
if (!storeInst)
|
|
1021
|
-
throw new
|
|
1086
|
+
throw new DatedError(`Can't deserialize data because no DataStore instance with the ID "${effectiveId}" was found! Make sure to provide it in the DataStoreSerializer constructor.`);
|
|
1022
1087
|
if (this.options.ensureIntegrity && typeof storeData.checksum === "string") {
|
|
1023
1088
|
const checksum = await this.calcChecksum(storeData.data);
|
|
1024
1089
|
if (checksum !== storeData.checksum)
|
|
@@ -1189,11 +1254,12 @@ var NanoEmitter = class {
|
|
|
1189
1254
|
* `callback` (required) is the function that will be called when the conditions are met.
|
|
1190
1255
|
*
|
|
1191
1256
|
* Set `once` to true to call the callback only once for the first event (or set of events) that match the criteria, then stop listening.
|
|
1192
|
-
* If `signal` is provided, the subscription will be
|
|
1257
|
+
* If `signal` is provided, the subscription will be canceled when the given signal is aborted.
|
|
1193
1258
|
*
|
|
1194
1259
|
* If `oneOf` is used, the callback will be called when any of the matching events are emitted.
|
|
1195
1260
|
* If `allOf` is used, the callback will be called after all of the matching events are emitted at least once, then any time any of them are emitted.
|
|
1196
|
-
*
|
|
1261
|
+
* If both `oneOf` and `allOf` are used together, the callback will be called when any of the `oneOf` events are emitted AND all of the `allOf` events have been emitted at least once.
|
|
1262
|
+
* At least one of `oneOf` or `allOf` must be provided.
|
|
1197
1263
|
*
|
|
1198
1264
|
* @returns Returns a function that can be called to unsubscribe all listeners created by this call. Alternatively, pass an `AbortSignal` to all options objects to achieve the same effect or for finer control.
|
|
1199
1265
|
*/
|
|
@@ -1221,6 +1287,8 @@ var NanoEmitter = class {
|
|
|
1221
1287
|
} = optsWithDefaults;
|
|
1222
1288
|
if (signal == null ? void 0 : signal.aborted)
|
|
1223
1289
|
return unsubAll;
|
|
1290
|
+
if (oneOf.length === 0 && allOf.length === 0)
|
|
1291
|
+
throw new TypeError("NanoEmitter.onMulti(): Either `oneOf` or `allOf` or both must be provided in the options");
|
|
1224
1292
|
const curEvtUnsubs = [];
|
|
1225
1293
|
const checkUnsubAllEvt = (force = false) => {
|
|
1226
1294
|
if (!(signal == null ? void 0 : signal.aborted) && !force)
|
|
@@ -1230,34 +1298,31 @@ var NanoEmitter = class {
|
|
|
1230
1298
|
curEvtUnsubs.splice(0, curEvtUnsubs.length);
|
|
1231
1299
|
this.eventUnsubscribes = this.eventUnsubscribes.filter((u) => !curEvtUnsubs.includes(u));
|
|
1232
1300
|
};
|
|
1301
|
+
const allOfEmitted = /* @__PURE__ */ new Set();
|
|
1302
|
+
const allOfConditionMet = () => allOf.length === 0 || allOfEmitted.size === allOf.length;
|
|
1233
1303
|
for (const event of oneOf) {
|
|
1234
1304
|
const unsub = this.events.on(event, ((...args) => {
|
|
1235
1305
|
checkUnsubAllEvt();
|
|
1236
|
-
|
|
1237
|
-
|
|
1238
|
-
|
|
1306
|
+
if (allOfConditionMet()) {
|
|
1307
|
+
callback(event, ...args);
|
|
1308
|
+
if (once)
|
|
1309
|
+
checkUnsubAllEvt(true);
|
|
1310
|
+
}
|
|
1239
1311
|
}));
|
|
1240
1312
|
curEvtUnsubs.push(unsub);
|
|
1241
1313
|
}
|
|
1242
|
-
const allOfEmitted = /* @__PURE__ */ new Set();
|
|
1243
|
-
const checkAllOf = (event, ...args) => {
|
|
1244
|
-
checkUnsubAllEvt();
|
|
1245
|
-
allOfEmitted.add(event);
|
|
1246
|
-
if (allOfEmitted.size === allOf.length) {
|
|
1247
|
-
callback(event, ...args);
|
|
1248
|
-
if (once)
|
|
1249
|
-
checkUnsubAllEvt(true);
|
|
1250
|
-
}
|
|
1251
|
-
};
|
|
1252
1314
|
for (const event of allOf) {
|
|
1253
1315
|
const unsub = this.events.on(event, ((...args) => {
|
|
1254
1316
|
checkUnsubAllEvt();
|
|
1255
|
-
|
|
1317
|
+
allOfEmitted.add(event);
|
|
1318
|
+
if (allOfConditionMet() && (oneOf.length === 0 || oneOf.includes(event))) {
|
|
1319
|
+
callback(event, ...args);
|
|
1320
|
+
if (once)
|
|
1321
|
+
checkUnsubAllEvt(true);
|
|
1322
|
+
}
|
|
1256
1323
|
}));
|
|
1257
1324
|
curEvtUnsubs.push(unsub);
|
|
1258
1325
|
}
|
|
1259
|
-
if (oneOf.length === 0 && allOf.length === 0)
|
|
1260
|
-
throw new TypeError("NanoEmitter.onMulti(): Either `oneOf` or `allOf` or both must be provided in the options");
|
|
1261
1326
|
allUnsubs.push(() => checkUnsubAllEvt(true));
|
|
1262
1327
|
}
|
|
1263
1328
|
return unsubAll;
|