@availity/mui-pagination 1.0.5 → 1.0.6

package/CHANGELOG.md

@@ -2,6 +2,13 @@
 
 This file was generated using [@jscutlery/semver](https://github.com/jscutlery/semver).
 
+## [1.0.6](https://github.com/Availity/element/compare/@availity/mui-pagination@1.0.5...@availity/mui-pagination@1.0.6) (2025-04-16)
+
+
+### Bug Fixes
+
+* **mui-pagination:** added missing export ([9ed0267](https://github.com/Availity/element/commit/9ed02670a87d81480add8139d21e536df8090f57))
+
 ## [1.0.5](https://github.com/Availity/element/compare/@availity/mui-pagination@1.0.4...@availity/mui-pagination@1.0.5) (2025-04-14)
 
 ### Dependency Updates

package/dist/index.d.mts

@@ -1,5 +1,6 @@
 import { PaginationProps as PaginationProps$1 } from '@mui/material/Pagination';
 import { PaginationItemProps as PaginationItemProps$1 } from '@mui/material/PaginationItem';
+import * as _tanstack_react_query from '@tanstack/react-query';
 
 type PaginationProps = {
     /** The size of the component
@@ -11,4 +12,35 @@ declare const Pagination: (props: PaginationProps) => JSX.Element;
 type PaginationItemProps = Omit<PaginationItemProps$1, 'components' | 'color' | 'shape' | 'size'>;
 declare const PaginationItem: (props: PaginationItemProps) => JSX.Element;
 
-export { Pagination, PaginationItem, type PaginationItemProps, type PaginationProps };
+type Resource<TData> = {
+    postGet: (request: {
+        limit: number;
+        offset: number;
+    } & Record<string, unknown>, config: unknown) => Promise<{
+        data: TData & {
+            totalCount: number;
+        };
+    }>;
+    getResult: string | ((result: TData) => unknown[]);
+    addParams: (data: Record<string, unknown>, config: Record<string, unknown>) => unknown;
+};
+type LoadPageProps<TData> = {
+    page: number;
+    /** When a function, the function is called with the response body from the API call and is expected to return an array containing the list of items for the page. When a string, the string is expected to be a simple key used to get the value from the response. ("simple" means dot notation is not supported for grabbing values from nested objects. If your result is deeply nested, provide a function) */
+    getResult: string | ((result: TData) => unknown[]);
+    /** If array, defaults `totalCount` to the length of the array, and page values are sliced from the Array. If a function, it is called with the current page as an argument and expects an array of items to be returned. */
+    itemsPerPage?: number;
+    /** Object use to create querystring parameters in the request. */
+    parameters?: {
+        params?: Record<string, unknown>;
+    } & Record<string, unknown>;
+    /** Availity API resource (see [@availity/api-axios](https://github.com/Availity/sdk-js/tree/master/packages/api-axios)).  */
+    resource: Resource<TData>;
+};
+/** @requires `@tanstack/react-query` peer dependency */
+declare const useResourcePagination: <TData>({ page, itemsPerPage, parameters, getResult, resource, }: LoadPageProps<TData>) => _tanstack_react_query.UseQueryResult<{
+    items: TData[];
+    totalCount: number;
+}, unknown>;
+
+export { type LoadPageProps, Pagination, PaginationItem, type PaginationItemProps, type PaginationProps, useResourcePagination };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 import { PaginationProps as PaginationProps$1 } from '@mui/material/Pagination';
 import { PaginationItemProps as PaginationItemProps$1 } from '@mui/material/PaginationItem';
+import * as _tanstack_react_query from '@tanstack/react-query';
 
 type PaginationProps = {
     /** The size of the component
@@ -11,4 +12,35 @@ declare const Pagination: (props: PaginationProps) => JSX.Element;
 type PaginationItemProps = Omit<PaginationItemProps$1, 'components' | 'color' | 'shape' | 'size'>;
 declare const PaginationItem: (props: PaginationItemProps) => JSX.Element;
 
-export { Pagination, PaginationItem, type PaginationItemProps, type PaginationProps };
+type Resource<TData> = {
+    postGet: (request: {
+        limit: number;
+        offset: number;
+    } & Record<string, unknown>, config: unknown) => Promise<{
+        data: TData & {
+            totalCount: number;
+        };
+    }>;
+    getResult: string | ((result: TData) => unknown[]);
+    addParams: (data: Record<string, unknown>, config: Record<string, unknown>) => unknown;
+};
+type LoadPageProps<TData> = {
+    page: number;
+    /** When a function, the function is called with the response body from the API call and is expected to return an array containing the list of items for the page. When a string, the string is expected to be a simple key used to get the value from the response. ("simple" means dot notation is not supported for grabbing values from nested objects. If your result is deeply nested, provide a function) */
+    getResult: string | ((result: TData) => unknown[]);
+    /** If array, defaults `totalCount` to the length of the array, and page values are sliced from the Array. If a function, it is called with the current page as an argument and expects an array of items to be returned. */
+    itemsPerPage?: number;
+    /** Object use to create querystring parameters in the request. */
+    parameters?: {
+        params?: Record<string, unknown>;
+    } & Record<string, unknown>;
+    /** Availity API resource (see [@availity/api-axios](https://github.com/Availity/sdk-js/tree/master/packages/api-axios)).  */
+    resource: Resource<TData>;
+};
+/** @requires `@tanstack/react-query` peer dependency */
+declare const useResourcePagination: <TData>({ page, itemsPerPage, parameters, getResult, resource, }: LoadPageProps<TData>) => _tanstack_react_query.UseQueryResult<{
+    items: TData[];
+    totalCount: number;
+}, unknown>;
+
+export { type LoadPageProps, Pagination, PaginationItem, type PaginationItemProps, type PaginationProps, useResourcePagination };

package/dist/index.js

@@ -43,12 +43,33 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
   mod
 ));
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
   Pagination: () => Pagination,
-  PaginationItem: () => PaginationItem
+  PaginationItem: () => PaginationItem,
+  useResourcePagination: () => useResourcePagination
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -90,8 +111,44 @@ var getItemAriaLabel = (type, page) => {
 var Pagination = (props) => {
   return /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(import_Pagination.default, __spreadProps(__spreadValues({}, props), { getItemAriaLabel, renderItem: (item) => /* @__PURE__ */ (0, import_jsx_runtime2.jsx)(PaginationItem, __spreadValues({}, item)) }));
 };
+
+// src/lib/ResourcePagination.tsx
+var import_react_query = require("@tanstack/react-query");
+var loadPage = (_0) => __async(void 0, [_0], function* ({
+  page,
+  itemsPerPage = 10,
+  parameters = {},
+  getResult,
+  resource
+}) {
+  const data = __spreadValues({
+    limit: itemsPerPage,
+    offset: (page - 1) * itemsPerPage
+  }, parameters.params);
+  const config = resource.addParams(data, parameters);
+  const resp = yield resource.postGet(data, config);
+  const useGetResult = getResult || resource.getResult;
+  const items = (typeof useGetResult === "function" ? useGetResult.call(resource, resp.data) : resp.data[useGetResult]) || resp.data;
+  if (!Array.isArray(items)) {
+    throw new TypeError(
+      `Expected data to be an array but got \`${typeof items}\`. Use the \`getResult\` prop to specify how to get the data from the API response.`
+    );
+  }
+  return {
+    items,
+    totalCount: resp.data.totalCount
+  };
+});
+var useResourcePagination = ({
+  page,
+  itemsPerPage,
+  parameters,
+  getResult,
+  resource
+}) => (0, import_react_query.useQuery)(["resource", page], () => loadPage({ page, itemsPerPage, parameters, getResult, resource }));
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   Pagination,
-  PaginationItem
+  PaginationItem,
+  useResourcePagination
 });

package/dist/index.mjs

@@ -17,6 +17,26 @@ var __spreadValues = (a, b) => {
   return a;
 };
 var __spreadProps = (a, b) => __defProps(a, __getOwnPropDescs(b));
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
 
 // src/lib/Pagination.tsx
 import { default as MuiPagination } from "@mui/material/Pagination";
@@ -58,7 +78,43 @@ var getItemAriaLabel = (type, page) => {
 var Pagination = (props) => {
   return /* @__PURE__ */ jsx2(MuiPagination, __spreadProps(__spreadValues({}, props), { getItemAriaLabel, renderItem: (item) => /* @__PURE__ */ jsx2(PaginationItem, __spreadValues({}, item)) }));
 };
+
+// src/lib/ResourcePagination.tsx
+import { useQuery } from "@tanstack/react-query";
+var loadPage = (_0) => __async(void 0, [_0], function* ({
+  page,
+  itemsPerPage = 10,
+  parameters = {},
+  getResult,
+  resource
+}) {
+  const data = __spreadValues({
+    limit: itemsPerPage,
+    offset: (page - 1) * itemsPerPage
+  }, parameters.params);
+  const config = resource.addParams(data, parameters);
+  const resp = yield resource.postGet(data, config);
+  const useGetResult = getResult || resource.getResult;
+  const items = (typeof useGetResult === "function" ? useGetResult.call(resource, resp.data) : resp.data[useGetResult]) || resp.data;
+  if (!Array.isArray(items)) {
+    throw new TypeError(
+      `Expected data to be an array but got \`${typeof items}\`. Use the \`getResult\` prop to specify how to get the data from the API response.`
+    );
+  }
+  return {
+    items,
+    totalCount: resp.data.totalCount
+  };
+});
+var useResourcePagination = ({
+  page,
+  itemsPerPage,
+  parameters,
+  getResult,
+  resource
+}) => useQuery(["resource", page], () => loadPage({ page, itemsPerPage, parameters, getResult, resource }));
 export {
   Pagination,
-  PaginationItem
+  PaginationItem,
+  useResourcePagination
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@availity/mui-pagination",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "description": "Availity MUI Pagination Component - part of the @availity/element design system",
   "keywords": [
     "react",

package/src/index.ts

@@ -1,2 +1,3 @@
 export * from './lib/Pagination';
 export * from './lib/PaginationItem';
+export * from './lib/ResourcePagination';