feat(gallery-web): update derived loader controller to use refresh interval

Author: samuelreichert

packages/pluggableWidgets/gallery-web/src/controllers/DerivedLoaderController.ts

@@ -1,23 +1,50 @@
-import { DatasourceController } from "@mendix/widget-plugin-grid/query/DatasourceController";
 import { computed, makeObservable } from "mobx";
 
+type DerivedLoaderControllerSpec = {
+    showSilentRefresh: boolean;
+    refreshIndicator: boolean;
+    query: {
+        isFetchingNextBatch: boolean;
+        isFirstLoad: boolean;
+        isRefreshing: boolean;
+        isSilentRefresh: boolean;
+    };
+};
+
 export class DerivedLoaderController {
-    constructor(
-        private datasourceController: DatasourceController,
-        private refreshIndicator: boolean
-    ) {
+    constructor(private spec: DerivedLoaderControllerSpec) {
         makeObservable(this, {
-            isRefreshing: computed,
-            showRefreshIndicator: computed
+            isFirstLoad: computed,
+            isFetchingNextBatch: computed,
+            isRefreshing: computed
         });
     }
 
+    get isFirstLoad(): boolean {
+        const { query } = this.spec;
+
+        return query.isFirstLoad;
+    }
+
+    get isFetchingNextBatch(): boolean {
+        return this.spec.query.isFetchingNextBatch;
+    }
+
     get isRefreshing(): boolean {
-        const { isSilentRefresh, isRefreshing } = this.datasourceController;
+        const { isSilentRefresh, isRefreshing } = this.spec.query;
+
+        if (this.spec.showSilentRefresh) {
+            return isSilentRefresh || isRefreshing;
+        }
+
         return !isSilentRefresh && isRefreshing;
     }
 
     get showRefreshIndicator(): boolean {
-        return this.refreshIndicator && this.isRefreshing;
+        if (!this.spec.refreshIndicator) {
+            return false;
+        }
+
+        return this.isRefreshing;
     }
 }

packages/pluggableWidgets/gallery-web/src/stores/GalleryStore.ts

@@ -37,6 +37,7 @@ interface StaticProps {
     storeFilters: boolean;
     storeSort: boolean;
     refreshIndicator: boolean;
+    refreshInterval: number;
 }
 
 export type GalleryPropsGate = DerivedPropsGate<DynamicProps>;
@@ -99,10 +100,14 @@ export class GalleryStore extends BaseControllerHost {
             host: this._sortHost
         };
 
-        this.loaderCtrl = new DerivedLoaderController(this._query, spec.refreshIndicator);
+        this.loaderCtrl = new DerivedLoaderController({
+            showSilentRefresh: spec.refreshInterval > 1,
+            refreshIndicator: spec.refreshIndicator,
+            query: this._query
+        });
 
         new RefreshController(this, {
-            delay: 0,
+            delay: spec.refreshInterval * 1000,
             query: this._query.derivedQuery
         });