@ngx-pwa/local-storage 18.0.0 → 20.0.0

package/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2016-2024 Cyrille Tuzi
+Copyright (c) 2016-2025 Cyrille Tuzi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

package/fesm2022/ngx-pwa-local-storage.mjs

@@ -12,10 +12,7 @@ const IDB_BROKEN_ERROR = "indexedDB is not working";
  * Exception raised when `indexedDB` is not working
  */
 class IDBBrokenError extends Error {
-    constructor() {
-        super(...arguments);
-        this.message = IDB_BROKEN_ERROR;
-    }
+    message = IDB_BROKEN_ERROR;
 }
 /**
  * Exception message when a value cannot be serialized for `localStorage`
@@ -26,10 +23,7 @@ where data must be serialized, and the provided data can't be serialized.`;
  * Exception throwned when a value cannot be serialized for `localStorage`
  */
 class SerializationError extends Error {
-    constructor() {
-        super(...arguments);
-        this.message = SERIALIZATION_ERROR;
-    }
+    message = SERIALIZATION_ERROR;
 }
 
 /**
@@ -169,19 +163,23 @@ class StorageModule {
         return {
             ngModule: StorageModule,
             providers: [
-                config.LSPrefix ? { provide: LS_PREFIX, useValue: config.LSPrefix } : [],
-                config.IDBDBName ? { provide: IDB_DB_NAME, useValue: config.IDBDBName } : [],
-                config.IDBStoreName ? { provide: IDB_STORE_NAME, useValue: config.IDBStoreName } : [],
-                config.IDBDBVersion ? { provide: IDB_DB_VERSION, useValue: config.IDBDBVersion } : [],
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                config.LSPrefix !== undefined ? { provide: LS_PREFIX, useValue: config.LSPrefix } : [],
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                config.IDBDBName !== undefined ? { provide: IDB_DB_NAME, useValue: config.IDBDBName } : [],
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                config.IDBStoreName !== undefined ? { provide: IDB_STORE_NAME, useValue: config.IDBStoreName } : [],
+                // eslint-disable-next-line @typescript-eslint/no-deprecated
+                config.IDBDBVersion !== undefined ? { provide: IDB_DB_VERSION, useValue: config.IDBDBVersion } : [],
                 (config.IDBNoWrap === false) ? { provide: IDB_NO_WRAP, useValue: config.IDBNoWrap } : [],
             ],
         };
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: StorageModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule }); }
-    static { this.ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "18.0.0", ngImport: i0, type: StorageModule }); }
-    static { this.ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: StorageModule }); }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: StorageModule, deps: [], target: i0.ɵɵFactoryTarget.NgModule });
+    static ɵmod = i0.ɵɵngDeclareNgModule({ minVersion: "14.0.0", version: "20.0.0", ngImport: i0, type: StorageModule });
+    static ɵinj = i0.ɵɵngDeclareInjector({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: StorageModule });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: StorageModule, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: StorageModule, decorators: [{
             type: NgModule
         }] });
 
@@ -194,16 +192,17 @@ Check your JSON schema, otherwise it means data has been corrupted.`;
  * Exception throwned when a value is not valid against the JSON schema
  */
 class ValidationError extends Error {
-    constructor() {
-        super(...arguments);
-        this.message = VALIDATION_ERROR;
-    }
+    message = VALIDATION_ERROR;
 }
 
 class LocalStorageDatabase {
+    /**
+     * Optional user prefix to avoid collision for multiple apps on the same subdomain
+     */
+    prefix;
     constructor() {
         /* Prefix if asked, or no prefix otherwise */
-        this.prefix = inject(LS_PREFIX) || "";
+        this.prefix = inject(LS_PREFIX);
     }
     /**
      * Number of items in `localStorage`
@@ -229,6 +228,7 @@ class LocalStorageDatabase {
                 return of(parsedData);
             }
             catch (error) {
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
                 return throwError(() => error);
             }
         }
@@ -244,15 +244,19 @@ class LocalStorageDatabase {
         let serializedData = null;
         /* Check if data can be serialized */
         const dataPrototype = Object.getPrototypeOf(data);
-        if ((typeof data === "object") && (data !== null) && !Array.isArray(data) &&
+        if ((typeof data === "object") && !Array.isArray(data) &&
             !((dataPrototype === Object.prototype) || (dataPrototype === null))) {
             return throwError(() => new SerializationError());
         }
         /* Try to stringify (can fail on circular references) */
         try {
             serializedData = JSON.stringify(data);
+            if (serializedData === undefined) {
+                throw new Error();
+            }
         }
         catch (error) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
             return throwError(() => error);
         }
         /* Can fail if storage quota is exceeded */
@@ -260,6 +264,7 @@ class LocalStorageDatabase {
             localStorage.setItem(this.prefixKey(key), serializedData);
         }
         catch (error) {
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
             return throwError(() => error);
         }
         /* Wrap in a RxJS `Observable` to be consistent with other storages */
@@ -329,7 +334,7 @@ class LocalStorageDatabase {
         const prefixedKey = localStorage.key(index);
         if (prefixedKey !== null) {
             /* If no prefix, the key is already good, otherwrite strip the prefix */
-            return !this.prefix ? prefixedKey : prefixedKey.substring(this.prefix.length);
+            return this.prefix === "" ? prefixedKey : prefixedKey.substring(this.prefix.length);
         }
         return null;
     }
@@ -341,10 +346,10 @@ class LocalStorageDatabase {
     prefixKey(key) {
         return `${this.prefix}${key}`;
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: LocalStorageDatabase, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: LocalStorageDatabase, providedIn: "root" }); }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: LocalStorageDatabase, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: LocalStorageDatabase, providedIn: "root" });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: LocalStorageDatabase, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: LocalStorageDatabase, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: "root"
@@ -352,12 +357,10 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImpor
         }], ctorParameters: () => [] });
 
 class MemoryDatabase {
-    constructor() {
-        /**
-         * Memory storage
-         */
-        this.memoryStorage = new Map();
-    }
+    /**
+     * Memory storage
+     */
+    memoryStorage = new Map();
     /**
      * Number of items in memory
      */
@@ -421,10 +424,10 @@ class MemoryDatabase {
         /* Wrap in a RxJS `Observable` to be consistent with other storages */
         return of(this.memoryStorage.has(key));
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: MemoryDatabase, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: MemoryDatabase, providedIn: "root" }); }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: MemoryDatabase, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: MemoryDatabase, providedIn: "root" });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: MemoryDatabase, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: MemoryDatabase, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: "root"
@@ -479,10 +482,10 @@ function localDatabaseFactory() {
     return new MemoryDatabase();
 }
 class LocalDatabase {
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: LocalDatabase, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: LocalDatabase, providedIn: "root", useFactory: localDatabaseFactory }); }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: LocalDatabase, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: LocalDatabase, providedIn: "root", useFactory: localDatabaseFactory });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: LocalDatabase, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: LocalDatabase, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: "root",
@@ -491,16 +494,32 @@ i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImpor
         }] });
 
 class IndexedDBDatabase {
+    /**
+     * `indexedDB` database name
+     */
+    dbName;
+    /**
+     * `indexedDB` object store name
+     */
+    storeName;
+    /**
+     * `indexedDB` database version. Must be an unsigned **integer**
+     */
+    dbVersion;
+    /**
+     * `indexedDB` database connection, wrapped in a RxJS `ReplaySubject` to be able to access the connection
+     * even after the connection success event happened
+     */
+    database = new ReplaySubject(1);
+    /**
+     * Flag to not wrap `indexedDB` values for interoperability or to wrap for backward compatibility.
+     */
+    noWrap;
+    /**
+     * Index used when wrapping value. *For backward compatibility only.*
+     */
+    wrapIndex = "value";
     constructor() {
-        /**
-         * `indexedDB` database connection, wrapped in a RxJS `ReplaySubject` to be able to access the connection
-         * even after the connection success event happened
-         */
-        this.database = new ReplaySubject(1);
-        /**
-         * Index used when wrapping value. *For backward compatibility only.*
-         */
-        this.wrapIndex = "value";
         this.dbName = inject(IDB_DB_NAME);
         this.storeName = inject(IDB_STORE_NAME);
         this.dbVersion = inject(IDB_DB_VERSION);
@@ -642,7 +661,7 @@ class IndexedDBDatabase {
             /* Listen to success event */
             const success$ = fromEvent(request, "success").pipe(
             /* Stop the `Observable` when the cursor is `null` */
-            // eslint-disable-next-line rxjs/no-ignored-takewhile-value -- Required by indexedDb behavior, getting the result from the event does not always work
+            // // eslint-disable-next-line rxjs/no-ignored-takewhile-value -- Required by indexedDb behavior, getting the result from the event does not always work
             takeWhile(() => (request.result !== null)), 
             /* This lib only allows string keys, but user could have added other types of keys from outside
              * It's OK to cast as the cursor as been tested in the previous operator */
@@ -747,6 +766,7 @@ class IndexedDBDatabase {
             }
             catch (error) {
                 /* The store could have been deleted from outside */
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
                 return throwError(() => error);
             }
             /* Get the store from the transaction */
@@ -766,6 +786,7 @@ class IndexedDBDatabase {
         /* Throw on error to be able to catch errors in RxJS way.
          * Here `event.target` must be used, as `transactionOrRequest.error` will be `null`
          * if we are on the request and the error is only triggered later by the transaction */
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
         mergeMap((event) => throwError(() => event.target?.error)));
     }
     /**
@@ -781,10 +802,10 @@ class IndexedDBDatabase {
         /* Choose the first event to occur */
         return race([complete$, error$]);
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: IndexedDBDatabase, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: IndexedDBDatabase, providedIn: "root" }); }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: IndexedDBDatabase, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: IndexedDBDatabase, providedIn: "root" });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: IndexedDBDatabase, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: IndexedDBDatabase, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: "root"
@@ -837,7 +858,7 @@ class JSONValidator {
         if ((schema.minLength !== undefined) && (data.length < schema.minLength)) {
             return false;
         }
-        if (schema.pattern) {
+        if (schema.pattern !== undefined) {
             try {
                 const regularExpression = new RegExp(schema.pattern);
                 if (!regularExpression.test(data)) {
@@ -870,7 +891,7 @@ class JSONValidator {
             return false;
         }
         /* Test is done this way to not divide by 0 */
-        if (schema.multipleOf && !Number.isInteger(data / schema.multipleOf)) {
+        if (schema.multipleOf !== undefined && schema.multipleOf !== 0 && Number.isFinite(schema.multipleOf) && !Number.isInteger(data / schema.multipleOf)) {
             return false;
         }
         if ((schema.maximum !== undefined) && (data > schema.maximum)) {
@@ -918,7 +939,7 @@ class JSONValidator {
         if ((schema.minItems !== undefined) && (data.length < schema.minItems)) {
             return false;
         }
-        if (schema.uniqueItems) {
+        if (schema.uniqueItems === true) {
             /* Create a set to eliminate values with multiple occurences */
             const dataSet = new Set(data);
             if (data.length !== dataSet.size) {
@@ -928,12 +949,14 @@ class JSONValidator {
         /* Specific test for tuples */
         if (Array.isArray(schema.items) || schema.items === undefined) {
             // TODO: cast should not be needed here
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
             return this.validateTuple(data, schema.items);
         }
         /* Validate all the values in array */
         for (const value of data) {
             // TODO: remove when TypeScript 4.1 is available
             // (currently the narrowed type from `Array.isArray()` is lost on readonly arrays)
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
             if (!this.validate(value, schema.items)) {
                 return false;
             }
@@ -990,7 +1013,7 @@ class JSONValidator {
         for (const property in schema.properties) {
             /* Filter to keep only real properties (no internal JS stuff) and check if the data has the property too */
             if (Object.hasOwn(schema.properties, property) && Object.hasOwn(data, property)) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion -- Ensured by the logic
+                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion, @typescript-eslint/no-unsafe-type-assertion -- Ensured by the logic
                 if (!this.validate(data[property], schema.properties[property])) {
                     return false;
                 }
@@ -1005,7 +1028,7 @@ class JSONValidator {
      * @returns If data is valid: `true`, if it is invalid: `false`
      */
     validateConst(data, schema) {
-        if (!schema.const) {
+        if (schema.const === undefined) {
             return true;
         }
         return (data === schema.const);
@@ -1021,12 +1044,13 @@ class JSONValidator {
             return true;
         }
         /* Cast as the data can be of multiple types, and so TypeScript is lost */
+        // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
         return (schema.enum.includes(data));
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: JSONValidator, deps: [], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: JSONValidator, providedIn: "root" }); }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: JSONValidator, deps: [], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: JSONValidator, providedIn: "root" });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: JSONValidator, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: JSONValidator, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: "root"
@@ -1146,6 +1170,7 @@ class StorageMap {
                     return throwError(() => new ValidationError());
                 }
                 /* Data have been checked, so it's OK to cast */
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
                 return of(data);
             }
             /* Cast to unknown as the data wasn't checked */
@@ -1287,6 +1312,7 @@ class StorageMap {
         });
         /* Only the public API of the Observable should be returned */
         return (schema ?
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-type-assertion
             notifier.asObservable() :
             notifier.asObservable());
     }
@@ -1346,15 +1372,15 @@ class StorageMap {
      * @private
      * @ignore
      */
-    // eslint-disable-next-line @typescript-eslint/ban-ts-comment, @typescript-eslint/prefer-ts-expect-error -- Silence the not used error, it is used in tests
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment -- Silence the not used error, it is used in tests
     // @ts-ignore
     ɵinternalGetDatabase() {
         return this.#database;
     }
-    static { this.ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: StorageMap, deps: [{ token: LocalDatabase }], target: i0.ɵɵFactoryTarget.Injectable }); }
-    static { this.ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: StorageMap, providedIn: "root" }); }
+    static ɵfac = i0.ɵɵngDeclareFactory({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: StorageMap, deps: [{ token: LocalDatabase }], target: i0.ɵɵFactoryTarget.Injectable });
+    static ɵprov = i0.ɵɵngDeclareInjectable({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: StorageMap, providedIn: "root" });
 }
-i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "18.0.0", ngImport: i0, type: StorageMap, decorators: [{
+i0.ɵɵngDeclareClassMetadata({ minVersion: "12.0.0", version: "20.0.0", ngImport: i0, type: StorageMap, decorators: [{
             type: Injectable,
             args: [{
                     providedIn: "root"