react-native-onyx 3.0.1 → 3.0.2

package/dist/storage/providers/IDBKeyValProvider/createStore.d.ts

@@ -0,0 +1,3 @@
+import type { UseStore } from 'idb-keyval';
+declare function createStore(dbName: string, storeName: string): UseStore;
+export default createStore;

package/dist/storage/providers/IDBKeyValProvider/createStore.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const idb_keyval_1 = require("idb-keyval");
+const Logger_1 = require("../../../Logger");
+// This is a copy of the createStore function from idb-keyval, we need a custom implementation
+// because we need to create the database manually in order to ensure that the store exists before we use it.
+// If the store does not exist, idb-keyval will throw an error
+// source: https://github.com/jakearchibald/idb-keyval/blob/9d19315b4a83897df1e0193dccdc29f78466a0f3/src/index.ts#L12
+function createStore(dbName, storeName) {
+    let dbp;
+    const getDB = () => {
+        if (dbp)
+            return dbp;
+        const request = indexedDB.open(dbName);
+        request.onupgradeneeded = () => request.result.createObjectStore(storeName);
+        dbp = (0, idb_keyval_1.promisifyRequest)(request);
+        dbp.then((db) => {
+            // It seems like Safari sometimes likes to just close the connection.
+            // It's supposed to fire this event when that happens. Let's hope it does!
+            // eslint-disable-next-line no-param-reassign
+            db.onclose = () => (dbp = undefined);
+        }, 
+        // eslint-disable-next-line @typescript-eslint/no-empty-function
+        () => { });
+        return dbp;
+    };
+    // Ensures the store exists in the DB. If missing, bumps the version to trigger
+    // onupgradeneeded, recreates the store, and returns a promise to the new DB.
+    const verifyStoreExists = (db) => {
+        if (db.objectStoreNames.contains(storeName)) {
+            return db;
+        }
+        (0, Logger_1.logInfo)(`Store ${storeName} does not exist in database ${dbName}.`);
+        const nextVersion = db.version + 1;
+        db.close();
+        const request = indexedDB.open(dbName, nextVersion);
+        request.onupgradeneeded = () => {
+            const updatedDatabase = request.result;
+            if (updatedDatabase.objectStoreNames.contains(storeName)) {
+                return;
+            }
+            (0, Logger_1.logInfo)(`Creating store ${storeName} in database ${dbName}.`);
+            updatedDatabase.createObjectStore(storeName);
+        };
+        dbp = (0, idb_keyval_1.promisifyRequest)(request);
+        return dbp;
+    };
+    return (txMode, callback) => getDB()
+        .then(verifyStoreExists)
+        .then((db) => callback(db.transaction(storeName, txMode).objectStore(storeName)));
+}
+exports.default = createStore;

package/dist/storage/providers/{IDBKeyValProvider.d.ts → IDBKeyValProvider/index.d.ts}

@@ -1,3 +1,3 @@
-import type StorageProvider from './types';
+import type StorageProvider from '../types';
 declare const provider: StorageProvider;
 export default provider;

package/dist/storage/providers/{IDBKeyValProvider.js → IDBKeyValProvider/index.js}

@@ -4,10 +4,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const idb_keyval_1 = require("idb-keyval");
-const utils_1 = __importDefault(require("../../utils"));
+const utils_1 = __importDefault(require("../../../utils"));
+const createStore_1 = __importDefault(require("./createStore"));
 // We don't want to initialize the store while the JS bundle loads as idb-keyval will try to use global.indexedDB
 // which might not be available in certain environments that load the bundle (e.g. electron main process).
 let idbKeyValStore;
+const DB_NAME = 'OnyxDB';
+const STORE_NAME = 'keyvaluepairs';
 const provider = {
     /**
      * The name of the provider that can be printed to the logs
@@ -17,9 +20,10 @@ const provider = {
      * Initializes the storage provider
      */
     init() {
-        const newIdbKeyValStore = (0, idb_keyval_1.createStore)('OnyxDB', 'keyvaluepairs');
-        if (newIdbKeyValStore == null)
+        const newIdbKeyValStore = (0, createStore_1.default)(DB_NAME, STORE_NAME);
+        if (newIdbKeyValStore == null) {
             throw Error('IDBKeyVal store could not be created');
+        }
         idbKeyValStore = newIdbKeyValStore;
     },
     setItem: (key, value) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "3.0.1",
+  "version": "3.0.2",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",