@sv443-network/coreutils 3.0.0 → 3.0.2

package/dist/lib/DataStore.d.ts

@@ -3,7 +3,7 @@
  * This module contains the DataStore class, which is a general purpose, sync and async persistent database for JSON-serializable data - [see the documentation for more info](https://github.com/Sv443-Network/CoreUtils/blob/main/docs.md#class-datastore)  
  */
 import type { DataStoreEngine } from "./DataStoreEngine.ts";
-import type { LooseUnion, Prettify, SerializableVal } from "./types.ts";
+import type { LooseUnion, Prettify } from "./types.ts";
 /** Function that takes the data in the old format and returns the data in the new format. Also supports an asynchronous migration. */
 type MigrationFunc = (oldData: any) => any | Promise<any>;
 /** Dictionary of format version numbers and the function that migrates to them from the previous whole integer */
@@ -40,7 +40,7 @@ export type DataStoreOptions<TData extends DataStoreData> = Prettify<{
      *  
      * - ⚠️ Don't reuse the same engine instance for multiple DataStores, unless it explicitly supports it!  
      */
-    engine: (() => DataStoreEngine<TData>) | DataStoreEngine<TData>;
+    engine: (() => DataStoreEngine) | DataStoreEngine;
     /**
      * A dictionary of functions that can be used to migrate data from older versions to newer ones.  
      * The keys of the dictionary should be the format version that the functions can migrate to, from the previous whole integer value.  
@@ -94,8 +94,12 @@ export type DataStoreOptions<TData extends DataStoreData> = Prettify<{
     decodeData: DecodeTuple;
     compressionFormat?: never;
 })>;
-/** Generic type that represents the serializable data structure saved in a {@linkcode DataStore} instance. */
-export type DataStoreData<TData extends SerializableVal = SerializableVal> = Record<string, SerializableVal | TData>;
+/**
+ * Generic type that represents the serializable data structure saved in a {@linkcode DataStore} instance.  
+ * - ⚠️ Uses `object` instead of an index signature so that interfaces without an explicit index signature can be used as `TData`.  
+ *   Make sure to only use JSON-serializable types here, otherwise unexpected behavior may occur!  
+ */
+export type DataStoreData = object;
 /**
  * Manages a hybrid synchronous & asynchronous persistent JSON database that is cached in memory and persistently saved across sessions using one of the preset DataStoreEngines or your own one.  
  * Supports migrating data from older format versions to newer ones and populating the cache with default data if no persistent data is found.  
@@ -118,7 +122,7 @@ export declare class DataStore<TData extends DataStoreData> {
     readonly decodeData: DataStoreOptions<TData>["decodeData"];
     readonly compressionFormat: Exclude<DataStoreOptions<TData>["compressionFormat"], undefined>;
     readonly memoryCache: boolean;
-    readonly engine: DataStoreEngine<TData>;
+    readonly engine: DataStoreEngine;
     options: DataStoreOptions<TData>;
     /**
      * Whether all first-init checks should be done.  

package/dist/lib/DataStoreEngine.d.ts

@@ -6,8 +6,8 @@
 import type { DataStoreData, DataStoreOptions } from "./DataStore.ts";
 import type { Prettify, SerializableVal } from "./types.ts";
 /** Contains the only properties of {@linkcode DataStoreOptions} that are relevant to the {@linkcode DataStoreEngine} class. */
-export type DataStoreEngineDSOptions<TData extends DataStoreData> = Prettify<Pick<DataStoreOptions<TData>, "decodeData" | "encodeData" | "id">>;
-export interface DataStoreEngine<TData extends DataStoreData> {
+export type DataStoreEngineDSOptions<TData extends DataStoreData = DataStoreData> = Prettify<Pick<DataStoreOptions<TData>, "decodeData" | "encodeData" | "id">>;
+export interface DataStoreEngine<TData extends DataStoreData = DataStoreData> {
     /** Deletes all data in persistent storage, including the data container itself (e.g. a file or a database) */
     deleteStorage?(): Promise<void>;
 }
@@ -15,7 +15,7 @@ export interface DataStoreEngine<TData extends DataStoreData> {
  * Base class for creating {@linkcode DataStore} storage engines.  
  * This acts as an interchangeable API for writing and reading persistent JSON-serializable data in various environments.  
  */
-export declare abstract class DataStoreEngine<TData extends DataStoreData> {
+export declare abstract class DataStoreEngine<TData extends DataStoreData = DataStoreData> {
     protected dataStoreOptions: DataStoreEngineDSOptions<TData>;
     constructor(options?: DataStoreEngineDSOptions<TData>);
     /** Called by DataStore on creation, to pass its options. Only call this if you are using this instance standalone! */
@@ -54,7 +54,7 @@ export type BrowserStorageEngineOptions = {
  * - ⚠️ Requires a DOM environment  
  * - ⚠️ Don't reuse engine instances, always create a new one for each {@linkcode DataStore} instance  
  */
-export declare class BrowserStorageEngine<TData extends DataStoreData> extends DataStoreEngine<TData> {
+export declare class BrowserStorageEngine<TData extends DataStoreData = DataStoreData> extends DataStoreEngine<TData> {
     protected options: BrowserStorageEngineOptions & Required<Pick<BrowserStorageEngineOptions, "type">>;
     /**
      * Creates an instance of `BrowserStorageEngine`.  
@@ -86,7 +86,7 @@ export type FileStorageEngineOptions = {
  * - ⚠️ Requires Node.js or Deno with Node compatibility (v1.31+)  
  * - ⚠️ Don't reuse engine instances, always create a new one for each {@linkcode DataStore} instance  
  */
-export declare class FileStorageEngine<TData extends DataStoreData> extends DataStoreEngine<TData> {
+export declare class FileStorageEngine<TData extends DataStoreData = DataStoreData> extends DataStoreEngine<TData> {
     protected options: FileStorageEngineOptions & Required<Pick<FileStorageEngineOptions, "filePath">>;
     private fileAccessQueue;
     /**

package/dist/lib/DataStoreSerializer.d.ts

@@ -42,10 +42,10 @@ export type StoreFilter = string[] | ((id: string) => boolean);
  *  
  * - ⚠️ Needs to run in a secure context (HTTPS) due to the use of the SubtleCrypto API if checksumming is enabled.  
  */
-export declare class DataStoreSerializer<TData extends DataStoreData> {
-    protected stores: DataStore<TData>[];
+export declare class DataStoreSerializer {
+    protected stores: DataStore<DataStoreData>[];
     protected options: Required<DataStoreSerializerOptions>;
-    constructor(stores: DataStore<TData>[], options?: DataStoreSerializerOptions);
+    constructor(stores: DataStore<DataStoreData>[], options?: DataStoreSerializerOptions);
     /** Calculates the checksum of a string */
     protected calcChecksum(input: string): Promise<string>;
     /**
@@ -114,5 +114,5 @@ export declare class DataStoreSerializer<TData extends DataStoreData> {
     /** Checks if a given value is a SerializedDataStore object */
     static isSerializedDataStoreObj(obj: unknown): obj is SerializedDataStore;
     /** Returns the DataStore instances whose IDs match the provided array or function */
-    protected getStoresFiltered(stores?: StoreFilter): DataStore<TData>[];
+    protected getStoresFiltered(stores?: StoreFilter): DataStore<DataStoreData>[];
 }

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@sv443-network/coreutils",
   "libName": "@sv443-network/coreutils",
-  "version": "3.0.0",
+  "version": "3.0.2",
   "description": "Cross-platform, general-purpose, JavaScript core library for Node, Deno and the browser. Intended to be used in conjunction with `@sv443-network/userutils` and `@sv443-network/djsutils`, but can be used independently as well.",
   "main": "dist/CoreUtils.cjs",
   "module": "dist/CoreUtils.mjs",
   "types": "dist/lib/index.d.ts",
   "exports": {
     ".": {
-      "browser": "./dist/CoreUtils.min.umd.js",
+      "browser": "./dist/CoreUtils.mjs",
       "types": "./dist/lib/index.d.ts",
       "require": "./dist/CoreUtils.cjs",
       "import": "./dist/CoreUtils.mjs"
@@ -76,6 +76,9 @@
     "/CHANGELOG.md",
     "/LICENSE.txt"
   ],
+  "publishConfig": {
+    "provenance": true
+  },
   "scripts": {
     "lint": "eslint . && tsc --noEmit",
     "format": "eslint . --fix",