@trackunit/react-graphql-hooks 1.14.25 → 1.14.27

package/index.cjs.js

@@ -248,13 +248,19 @@ const useSyncedRef = (value) => {
     return ref;
 };
 /**
- * This hook is used to fetch data from a GraphQL query and support pagination, it will help maintain the data and the pagination.
+ * `usePaginationQuery` fetches data from a GraphQL query with Relay-style cursor pagination.
+ * It manages page accumulation, loading state, and provides `pagination` controls (including `fetchNext`)
+ * compatible with the Table component's `pagination` prop.
  *
- * Data will be the combined data from all pages, if you merge in the updateQuery.
+ * The `updateQuery` callback merges newly fetched pages into the accumulated dataset. Use
+ * `unionEdgesByNodeKey` to deduplicate and merge edges across pages.
  *
- * It will use pagination.fetchNext to fetch next page and call updateQuery where you can merge the data together.
+ * ### When to use
+ * Use usePaginationQuery for any paginated GraphQL list — for example, loading an asset list
+ * or event log with infinite scroll via the Table component.
  *
- * lastFetchedData is used to store the last fetched data, so you can update data according to last page.
+ * ### When not to use
+ * Do not use usePaginationQuery for single-entity queries without pagination — use `useQuery` from Apollo Client directly.
  *
  * @example
  * const {

package/index.esm.js

@@ -246,13 +246,19 @@ const useSyncedRef = (value) => {
     return ref;
 };
 /**
- * This hook is used to fetch data from a GraphQL query and support pagination, it will help maintain the data and the pagination.
+ * `usePaginationQuery` fetches data from a GraphQL query with Relay-style cursor pagination.
+ * It manages page accumulation, loading state, and provides `pagination` controls (including `fetchNext`)
+ * compatible with the Table component's `pagination` prop.
  *
- * Data will be the combined data from all pages, if you merge in the updateQuery.
+ * The `updateQuery` callback merges newly fetched pages into the accumulated dataset. Use
+ * `unionEdgesByNodeKey` to deduplicate and merge edges across pages.
  *
- * It will use pagination.fetchNext to fetch next page and call updateQuery where you can merge the data together.
+ * ### When to use
+ * Use usePaginationQuery for any paginated GraphQL list — for example, loading an asset list
+ * or event log with infinite scroll via the Table component.
  *
- * lastFetchedData is used to store the last fetched data, so you can update data according to last page.
+ * ### When not to use
+ * Do not use usePaginationQuery for single-entity queries without pagination — use `useQuery` from Apollo Client directly.
  *
  * @example
  * const {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-graphql-hooks",
-  "version": "1.14.25",
+  "version": "1.14.27",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -12,7 +12,7 @@
     "@trackunit/i18n-library-translation": "1.12.28",
     "@trackunit/shared-utils": "1.13.43",
     "es-toolkit": "^1.39.10",
-    "@trackunit/react-components": "1.17.22"
+    "@trackunit/react-components": "1.17.24"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/usePaginationQuery.d.ts

@@ -36,13 +36,19 @@ export interface PaginationQueryProps<TData, TVariables extends ApolloOperationV
     skip?: boolean;
 }
 /**
- * This hook is used to fetch data from a GraphQL query and support pagination, it will help maintain the data and the pagination.
+ * `usePaginationQuery` fetches data from a GraphQL query with Relay-style cursor pagination.
+ * It manages page accumulation, loading state, and provides `pagination` controls (including `fetchNext`)
+ * compatible with the Table component's `pagination` prop.
  *
- * Data will be the combined data from all pages, if you merge in the updateQuery.
+ * The `updateQuery` callback merges newly fetched pages into the accumulated dataset. Use
+ * `unionEdgesByNodeKey` to deduplicate and merge edges across pages.
  *
- * It will use pagination.fetchNext to fetch next page and call updateQuery where you can merge the data together.
+ * ### When to use
+ * Use usePaginationQuery for any paginated GraphQL list — for example, loading an asset list
+ * or event log with infinite scroll via the Table component.
  *
- * lastFetchedData is used to store the last fetched data, so you can update data according to last page.
+ * ### When not to use
+ * Do not use usePaginationQuery for single-entity queries without pagination — use `useQuery` from Apollo Client directly.
  *
  * @example
  * const {