feat: Add and export isQueriesLoading and hasQueriesBeenLoaded

cozy · Oct 31, 2023 · d22c713 · d22c713
1 parent b170d2e
commit d22c713
Show file tree

Hide file tree

Showing 5 changed files with 72 additions and 2 deletions.
diff --git a/docs/api/cozy-client/README.md b/docs/api/cozy-client/README.md
@@ -449,6 +449,28 @@ Array of the reference found
 
 ***
 
+### hasQueriesBeenLoaded
+
+▸ **hasQueriesBeenLoaded**(`queriesResults`): `boolean`
+
+Returns whether queries have been loaded at least once
+
+*Parameters*
+
+| Name | Type |
+| :------ | :------ |
+| `queriesResults` | `any` |
+
+*Returns*
+
+`boolean`
+
+*Defined in*
+
+[packages/cozy-client/src/utils.js:66](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/utils.js#L66)
+
+***
+
 ### hasQueryBeenLoaded
 
 ▸ **hasQueryBeenLoaded**(`col`): `any`
@@ -471,6 +493,28 @@ Returns whether a query has been loaded at least once
 
 ***
 
+### isQueriesLoading
+
+▸ **isQueriesLoading**(`queriesResults`): `boolean`
+
+Returns whether the result of queries are loading
+
+*Parameters*
+
+| Name | Type |
+| :------ | :------ |
+| `queriesResults` | `any` |
+
+*Returns*
+
+`boolean`
+
+*Defined in*
+
+[packages/cozy-client/src/utils.js:57](https://github.com/cozy/cozy-client/blob/master/packages/cozy-client/src/utils.js#L57)
+
+***
+
 ### isQueryLoading
 
 ▸ **isQueryLoading**(`col`): `boolean`

diff --git a/packages/cozy-client/src/index.js b/packages/cozy-client/src/index.js
@@ -35,7 +35,13 @@ export {
   InvalidProtocolError,
   BlockedCozyError
 } from './helpers'
-export { cancelable, isQueryLoading, hasQueryBeenLoaded } from './utils'
+export {
+  cancelable,
+  isQueryLoading,
+  hasQueryBeenLoaded,
+  isQueriesLoading,
+  hasQueriesBeenLoaded
+} from './utils'
 export { getQueryFromState } from './store'
 export { default as Registry } from './registry'
 export { default as RealTimeQueries } from './RealTimeQueries'

diff --git a/packages/cozy-client/src/utils.js b/packages/cozy-client/src/utils.js
@@ -50,3 +50,21 @@ export const isQueryLoading = col => {
 export const hasQueryBeenLoaded = col => {
   return col.lastFetch
 }
+
+/**
+ * Returns whether the result of queries are loading
+ */
+export const isQueriesLoading = queriesResults => {
+  return Object.values(queriesResults).some(queryResult =>
+    isQueryLoading(queryResult)
+  )
+}
+
+/**
+ * Returns whether queries have been loaded at least once
+ */
+export const hasQueriesBeenLoaded = queriesResults => {
+  return Object.values(queriesResults).some(queryResult =>
+    hasQueryBeenLoaded(queryResult)
+  )
+}
diff --git a/packages/cozy-client/types/index.d.ts b/packages/cozy-client/types/index.d.ts
@@ -20,5 +20,5 @@ export { QueryDefinition, Q, Mutations, MutationTypes, getDoctypeFromOperation }
 export { Association, HasMany, HasOne, HasOneInPlace, HasManyInPlace, HasManyTriggers } from "./associations";
 export { isReferencedBy, isReferencedById, getReferencedBy, getReferencedById } from "./associations/helpers";
 export { deconstructCozyWebLinkWithSlug, deconstructRedirectLink, dehydrate, generateWebLink, ensureFirstSlash, rootCozyUrl, InvalidRedirectLinkError, InvalidCozyUrlError, InvalidProtocolError, BlockedCozyError } from "./helpers";
-export { cancelable, isQueryLoading, hasQueryBeenLoaded } from "./utils";
+export { cancelable, isQueryLoading, hasQueryBeenLoaded, isQueriesLoading, hasQueriesBeenLoaded } from "./utils";
 export { queryConnect, queryConnectFlat, withClient } from "./hoc";
diff --git a/packages/cozy-client/types/utils.d.ts b/packages/cozy-client/types/utils.d.ts
@@ -1,5 +1,7 @@
 export function isQueryLoading(col: any): boolean;
 export function hasQueryBeenLoaded(col: any): any;
+export function isQueriesLoading(queriesResults: any): boolean;
+export function hasQueriesBeenLoaded(queriesResults: any): boolean;
 export type CancelablePromise = Promise<any>;
 /**
  * @typedef {Promise} CancelablePromise