react-native-onyx 2.0.104 → 2.0.105

package/dist/index.d.ts

@@ -6,6 +6,7 @@ import type { Connection } from './OnyxConnectionManager';
 import useOnyx from './useOnyx';
 import withOnyx from './withOnyx';
 import type { WithOnyxState } from './withOnyx/types';
+import type { OnyxSQLiteKeyValuePair } from './storage/providers/SQLiteProvider';
 export default Onyx;
 export { useOnyx, withOnyx };
-export type { ConnectOptions, CustomTypeOptions, FetchStatus, KeyValueMapping, NullishDeep, OnyxCollection, OnyxEntry, OnyxKey, OnyxInputValue, OnyxCollectionInputValue, OnyxInput, OnyxSetInput, OnyxMultiSetInput, OnyxMergeInput, OnyxMergeCollectionInput, OnyxUpdate, OnyxValue, ResultMetadata, Selector, UseOnyxResult, WithOnyxState, Connection, UseOnyxOptions, };
+export type { ConnectOptions, CustomTypeOptions, FetchStatus, KeyValueMapping, NullishDeep, OnyxCollection, OnyxEntry, OnyxKey, OnyxInputValue, OnyxCollectionInputValue, OnyxInput, OnyxSetInput, OnyxMultiSetInput, OnyxMergeInput, OnyxMergeCollectionInput, OnyxUpdate, OnyxValue, ResultMetadata, Selector, UseOnyxResult, WithOnyxState, Connection, UseOnyxOptions, OnyxSQLiteKeyValuePair, };

package/dist/storage/__mocks__/index.d.ts

@@ -3,13 +3,13 @@ declare const StorageMock: {
     init: jest.Mock<void, []>;
     getItem: jest.Mock<Promise<unknown>, [key: any]>;
     multiGet: jest.Mock<Promise<import("../providers/types").KeyValuePairList>, [keys: import("../providers/types").KeyList]>;
-    setItem: jest.Mock<Promise<void | import("react-native-quick-sqlite").QueryResult>, [key: any, value: unknown]>;
-    multiSet: jest.Mock<Promise<void | import("react-native-quick-sqlite").BatchQueryResult>, [pairs: import("../providers/types").KeyValuePairList]>;
-    mergeItem: jest.Mock<Promise<void | import("react-native-quick-sqlite").BatchQueryResult>, [key: any, deltaChanges: unknown, preMergedValue: unknown, shouldSetValue?: boolean | undefined]>;
-    multiMerge: jest.Mock<Promise<void | import("react-native-quick-sqlite").BatchQueryResult | IDBValidKey[]>, [pairs: import("../providers/types").KeyValuePairList]>;
-    removeItem: jest.Mock<Promise<void | import("react-native-quick-sqlite").QueryResult>, [key: string]>;
-    removeItems: jest.Mock<Promise<void | import("react-native-quick-sqlite").QueryResult>, [keys: import("../providers/types").KeyList]>;
-    clear: jest.Mock<Promise<void | import("react-native-quick-sqlite").QueryResult>, []>;
+    setItem: jest.Mock<Promise<void | import("react-native-nitro-sqlite").QueryResult<import("react-native-nitro-sqlite").QueryResultRow>>, [key: any, value: unknown]>;
+    multiSet: jest.Mock<Promise<void | import("react-native-nitro-sqlite").BatchQueryResult>, [pairs: import("../providers/types").KeyValuePairList]>;
+    mergeItem: jest.Mock<Promise<void | import("react-native-nitro-sqlite").BatchQueryResult>, [key: any, deltaChanges: unknown, preMergedValue: unknown, shouldSetValue?: boolean | undefined]>;
+    multiMerge: jest.Mock<Promise<void | import("react-native-nitro-sqlite").BatchQueryResult | IDBValidKey[]>, [pairs: import("../providers/types").KeyValuePairList]>;
+    removeItem: jest.Mock<Promise<void | import("react-native-nitro-sqlite").QueryResult<import("react-native-nitro-sqlite").QueryResultRow>>, [key: string]>;
+    removeItems: jest.Mock<Promise<void | import("react-native-nitro-sqlite").QueryResult<import("react-native-nitro-sqlite").QueryResultRow>>, [keys: import("../providers/types").KeyList]>;
+    clear: jest.Mock<Promise<void | import("react-native-nitro-sqlite").QueryResult<import("react-native-nitro-sqlite").QueryResultRow>>, []>;
     getAllKeys: jest.Mock<Promise<import("../providers/types").KeyList>, []>;
     getDatabaseSize: jest.Mock<Promise<{
         bytesUsed: number;

package/dist/storage/providers/SQLiteProvider.d.ts

@@ -1,3 +1,13 @@
 import type StorageProvider from './types';
+/**
+ * The type of the key-value pair stored in the SQLite database
+ * @property record_key - the key of the record
+ * @property valueJSON - the value of the record in JSON string format
+ */
+type OnyxSQLiteKeyValuePair = {
+    record_key: string;
+    valueJSON: string;
+};
 declare const provider: StorageProvider;
 export default provider;
+export type { OnyxSQLiteKeyValuePair };

package/dist/storage/providers/SQLiteProvider.js

@@ -3,9 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const react_native_quick_sqlite_1 = require("react-native-quick-sqlite");
+const react_native_nitro_sqlite_1 = require("react-native-nitro-sqlite");
 const react_native_device_info_1 = require("react-native-device-info");
 const utils_1 = __importDefault(require("../../utils"));
+// By default, NitroSQLite does not accept nullish values due to current limitations in Nitro Modules.
+// This flag enables a feature in NitroSQLite that allows for nullish values to be passed to operations, such as "execute" or "executeBatch".
+// Simple null handling can potentially add a minor performance overhead,
+// since parameters and results from SQLite queries need to be parsed from and to JavaScript nullish values.
+// https://github.com/margelo/react-native-nitro-sqlite#sending-and-receiving-nullish-values
+(0, react_native_nitro_sqlite_1.enableSimpleNullHandling)();
 const DB_NAME = 'OnyxDB';
 let db;
 const provider = {
@@ -17,7 +23,7 @@ const provider = {
      * Initializes the storage provider
      */
     init() {
-        db = (0, react_native_quick_sqlite_1.open)({ name: DB_NAME });
+        db = (0, react_native_nitro_sqlite_1.open)({ name: DB_NAME });
         db.execute('CREATE TABLE IF NOT EXISTS keyvaluepairs (record_key TEXT NOT NULL PRIMARY KEY , valueJSON JSON NOT NULL) WITHOUT ROWID;');
         // All of the 3 pragmas below were suggested by SQLite team.
         // You can find more info about them here: https://www.sqlite.org/pragma.html
@@ -31,6 +37,9 @@ const provider = {
                 return null;
             }
             const result = rows === null || rows === void 0 ? void 0 : rows.item(0);
+            if (result == null) {
+                return null;
+            }
             return JSON.parse(result.valueJSON);
         });
     },
@@ -47,11 +56,12 @@ const provider = {
         return db.executeAsync('REPLACE INTO keyvaluepairs (record_key, valueJSON) VALUES (?, ?);', [key, JSON.stringify(value)]);
     },
     multiSet(pairs) {
-        const stringifiedPairs = pairs.map((pair) => [pair[0], JSON.stringify(pair[1] === undefined ? null : pair[1])]);
-        if (utils_1.default.isEmptyObject(stringifiedPairs)) {
+        const query = 'REPLACE INTO keyvaluepairs (record_key, valueJSON) VALUES (?, json(?));';
+        const params = pairs.map((pair) => [pair[0], JSON.stringify(pair[1] === undefined ? null : pair[1])]);
+        if (utils_1.default.isEmptyObject(params)) {
             return Promise.resolve();
         }
-        return db.executeBatchAsync([['REPLACE INTO keyvaluepairs (record_key, valueJSON) VALUES (?, json(?));', stringifiedPairs]]);
+        return db.executeBatchAsync([{ query, params }]);
     },
     multiMerge(pairs) {
         // Note: We use `ON CONFLICT DO UPDATE` here instead of `INSERT OR REPLACE INTO`
@@ -61,12 +71,12 @@ const provider = {
              ON CONFLICT DO UPDATE
              SET valueJSON = JSON_PATCH(valueJSON, JSON(:value));
         `;
-        const nonNullishPairs = pairs.filter((pair) => pair[1] !== undefined);
-        const queryArguments = nonNullishPairs.map((pair) => {
+        const nonUndefinedPairs = pairs.filter((pair) => pair[1] !== undefined);
+        const params = nonUndefinedPairs.map((pair) => {
             const value = JSON.stringify(pair[1]);
             return [pair[0], value];
         });
-        return db.executeBatchAsync([[query, queryArguments]]);
+        return db.executeBatchAsync([{ query, params }]);
     },
     mergeItem(key, deltaChanges, preMergedValue, shouldSetValue) {
         if (shouldSetValue) {
@@ -88,9 +98,9 @@ const provider = {
     clear: () => db.executeAsync('DELETE FROM keyvaluepairs;', []),
     getDatabaseSize() {
         return Promise.all([db.executeAsync('PRAGMA page_size;'), db.executeAsync('PRAGMA page_count;'), (0, react_native_device_info_1.getFreeDiskStorage)()]).then(([pageSizeResult, pageCountResult, bytesRemaining]) => {
-            var _a, _b;
-            const pageSize = (_a = pageSizeResult.rows) === null || _a === void 0 ? void 0 : _a.item(0).page_size;
-            const pageCount = (_b = pageCountResult.rows) === null || _b === void 0 ? void 0 : _b.item(0).page_count;
+            var _a, _b, _c, _d, _e, _f;
+            const pageSize = (_c = (_b = (_a = pageSizeResult.rows) === null || _a === void 0 ? void 0 : _a.item(0)) === null || _b === void 0 ? void 0 : _b.page_size) !== null && _c !== void 0 ? _c : 0;
+            const pageCount = (_f = (_e = (_d = pageCountResult.rows) === null || _d === void 0 ? void 0 : _d.item(0)) === null || _e === void 0 ? void 0 : _e.page_count) !== null && _f !== void 0 ? _f : 0;
             return {
                 bytesUsed: pageSize * pageCount,
                 bytesRemaining,

package/dist/storage/providers/types.d.ts

@@ -1,4 +1,4 @@
-import type { BatchQueryResult, QueryResult } from 'react-native-quick-sqlite';
+import type { BatchQueryResult, QueryResult } from 'react-native-nitro-sqlite';
 import type { OnyxKey, OnyxValue } from '../../types';
 type KeyValuePair = [OnyxKey, OnyxValue<OnyxKey>];
 type KeyList = OnyxKey[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "react-native-onyx",
-  "version": "2.0.104",
+  "version": "2.0.105",
   "author": "Expensify, Inc.",
   "homepage": "https://expensify.com",
   "description": "State management for React Native",
@@ -28,6 +28,7 @@
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
+    "prepare": "npm run build",
     "lint": "eslint .",
     "typecheck": "tsc --noEmit",
     "test": "jest",
@@ -86,10 +87,11 @@
     "prop-types": "^15.7.2",
     "react": "18.2.0",
     "react-dom": "^18.2.0",
-    "react-native": "0.71.2",
+    "react-native": "0.76.3",
     "react-native-device-info": "^10.3.0",
+    "react-native-nitro-modules": "^0.24.1",
+    "react-native-nitro-sqlite": "^9.1.8",
     "react-native-performance": "^2.0.0",
-    "react-native-quick-sqlite": "^8.0.6",
     "react-test-renderer": "18.1.0",
     "reassure": "1.4.0",
     "ts-node": "^10.9.2",
@@ -99,10 +101,12 @@
   "peerDependencies": {
     "idb-keyval": "^6.2.1",
     "react": ">=18.1.0",
+    "react-native": ">=0.75.0",
     "react-dom": ">=18.1.0",
     "react-native-device-info": "^10.3.0",
-    "react-native-performance": "^5.1.0",
-    "react-native-quick-sqlite": "^8.0.0-beta.2"
+    "react-native-nitro-modules": ">=0.24.1",
+    "react-native-nitro-sqlite": "^9.1.4",
+    "react-native-performance": "^5.1.0"
   },
   "peerDependenciesMeta": {
     "idb-keyval": {
@@ -111,7 +115,10 @@
     "react-native-performance": {
       "optional": true
     },
-    "react-native-quick-sqlite": {
+    "react-native-nitro-modules": {
+      "optional": true
+    },
+    "react-native-nitro-sqlite": {
       "optional": true
     },
     "react-native-device-info": {