Merge pull request #68 from haroldvandy2013/user/weiwang/response-metadata-getRange

add response metadata for DB getRange

Author: balaji-viswanathan

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/objectstoreprovider",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "A cross-browser object store library",
   "author": "Mukundan Kavanur Kidambi <mukav@microsoft.com>",
   "scripts": {

src/IndexedDbProvider.ts

@@ -1347,8 +1347,9 @@ class IndexedDbIndex extends DbIndexFTSFromRangeQueries {
     highRangeExclusive?: boolean,
     reverseOrSortOrder?: boolean | QuerySortOrder,
     limit?: number,
-    offset?: number
-  ): Promise<ItemType[]> {
+    offset?: number,
+    forceDisableGetAllRecords = false
+  ): Promise<ItemType[] & { isFromNewGetAllReverseMethod?: boolean }> {
     const keyRange = attempt(() => {
       return this._getKeyRangeForRange(
         keyLowRange,
@@ -1373,7 +1374,10 @@ class IndexedDbIndex extends DbIndexFTSFromRangeQueries {
       return IndexedDbProvider.WrapRequest(this._store.getAll(keyRange, limit));
     }
 
-    const shouldUseGetAllRecords = this.idbConfigs?.useGetAllRecordsForGetRange;
+    // use getAllRecords if it is allowed by config during init, and caller does not want to disable it
+    const shouldUseGetAllRecords =
+      this.idbConfigs?.useGetAllRecordsForGetRange &&
+      !forceDisableGetAllRecords;
     if (
       shouldUseGetAllRecords &&
       !!this._store.getAllRecords &&
@@ -1392,7 +1396,12 @@ class IndexedDbIndex extends DbIndexFTSFromRangeQueries {
 
       return IndexedDbProvider.WrapRequest(
         this._store.getAllRecords(query_options)
-      );
+      ).then((result) => {
+        if (!!result) {
+          (result as any).isFromNewGetAllReverseMethod = true;
+        }
+        return result;
+      });
     }
 
     const req = this._store.openCursor(keyRange, reverse ? "prev" : "next");

src/ObjectStoreProvider.ts

@@ -143,8 +143,9 @@ export interface DbIndex {
     highRangeExclusive?: boolean,
     reverseOrSortOrder?: boolean | QuerySortOrder,
     limit?: number,
-    offset?: number
-  ): Promise<ItemType[]>;
+    offset?: number,
+    forceDisableGetAllRecords?: boolean
+  ): Promise<ItemType[] & { isFromNewGetAllReverseMethod?: boolean }>;
   getKeysForRange(
     keyLowRange: KeyType,
     keyHighRange: KeyType,
@@ -374,8 +375,9 @@ export abstract class DbProvider {
     highRangeExclusive?: boolean,
     reverseOrSortOrder?: boolean | QuerySortOrder,
     limit?: number,
-    offset?: number
-  ): Promise<ItemType[]> {
+    offset?: number,
+    forceDisableGetAllRecords?: boolean
+  ): Promise<ItemType[] & { isFromNewGetAllReverseMethod?: boolean }> {
     return this._getStoreIndexTransaction(storeName, false, indexName).then(
       (index) => {
         return index.getRange(
@@ -385,7 +387,8 @@ export abstract class DbProvider {
           highRangeExclusive,
           reverseOrSortOrder,
           limit,
-          offset
+          offset,
+          forceDisableGetAllRecords
         );
       }
     );