@commercelayer/app-elements 2.8.3 → 2.10.0

package/dist/ui/resources/ResourceDetails/useEditDetailsOverlay.d.ts

@@ -0,0 +1,16 @@
+import { FC } from 'react';
+import { ResourceDetailsProps } from './ResourceDetails';
+export interface EditDetailsOverlayProps {
+    /**
+     * Optional title shown as first line in edit overlay heading
+     */
+    title?: string;
+    resource: ResourceDetailsProps['resource'];
+    onUpdated: ResourceDetailsProps['onUpdated'];
+}
+interface DetailsOverlayHook {
+    show: () => void;
+    Overlay: FC<EditDetailsOverlayProps>;
+}
+export declare function useEditDetailsOverlay(): DetailsOverlayHook;
+export {};

package/dist/ui/resources/ResourceLineItems/ResourceLineItems.d.ts

@@ -1,7 +1,6 @@
 import { LineItem, ParcelLineItem, ReturnLineItem } from '@commercelayer/sdk';
 import { ComponentProps } from 'react';
 import { StockLineItemWithStockTransfer } from './types';
-
 type Item = LineItem | ParcelLineItem | StockLineItemWithStockTransfer | ReturnLineItem;
 export type ResourceLineItemsProps = ComponentProps<typeof ResourceLineItems>;
 /**

package/dist/ui/resources/ResourceLineItems/types.d.ts

@@ -1,5 +1,4 @@
 import { StockLineItem, StockTransfer } from '@commercelayer/sdk';
-
 export type StockLineItemWithStockTransfer = StockLineItem & {
     stockTransfer?: StockTransfer;
 };

package/dist/ui/resources/ResourceListItem/ResourceListItem.d.ts

@@ -1,6 +1,5 @@
 import { ListItemProps } from '../../composite/ListItem';
 import { ResourceListItemType } from './types';
-
 export interface ResourceListItemProps {
     /**
      * Resource object used to generate list item content depending on its own type

package/dist/ui/resources/ResourceListItem/ResourceListItem.mocks.d.ts

@@ -363,6 +363,47 @@ export declare const presetResourceListItem: {
             };
         };
     };
+    returnRefunded: {
+        type: "returns";
+        id: string;
+        number: string;
+        updated_at: string;
+        created_at: string;
+        status: "refunded";
+        order: {
+            readonly type: "orders";
+            readonly id: "";
+            readonly updated_at: "2023-06-10T06:38:44.964Z";
+            readonly placed_at: "2023-06-09T11:00:00.000Z";
+            readonly created_at: "";
+            readonly formatted_total_amount: "$650.00";
+            readonly fulfillment_status: "unfulfilled";
+            readonly number: "123456";
+            readonly payment_status: "authorized";
+            readonly status: "placed";
+            readonly market: {
+                readonly type: "markets";
+                readonly id: "";
+                readonly name: "Europe";
+                readonly created_at: "";
+                readonly updated_at: "";
+                readonly shared_secret: "";
+            };
+            readonly billing_address: {
+                readonly first_name: "Bruce";
+                readonly last_name: "Wayne";
+                readonly type: "addresses";
+                readonly id: "";
+                readonly updated_at: "";
+                readonly created_at: "";
+                readonly line_1: "";
+                readonly state_code: "";
+                readonly phone: "";
+                readonly city: "";
+                readonly country_code: "";
+            };
+        };
+    };
     customerProspect: {
         type: "customers";
         id: string;

package/dist/ui/resources/ResourceListItem/common.d.ts

@@ -1,5 +1,4 @@
 import { DisplayStatus } from '../../../dictionaries/types';
-
 export declare const ListItemDescription: import('../../atoms/SkeletonTemplate').SkeletonTemplateComponent<{
     displayStatus: DisplayStatus;
     date: string;

package/dist/ui/resources/ResourceListItem/transformers/customers.d.ts

@@ -1,4 +1,3 @@
 import { Customer } from '@commercelayer/sdk';
 import { ResourceToProps } from '../types';
-
 export declare const customerToProps: ResourceToProps<Customer>;

package/dist/ui/resources/ResourceListItem/transformers/orders.d.ts

@@ -1,4 +1,3 @@
 import { Order } from '@commercelayer/sdk';
 import { ResourceToProps } from '../types';
-
 export declare const orderToProps: ResourceToProps<Order>;

package/dist/ui/resources/ResourceListItem/transformers/promotions.d.ts

@@ -1,4 +1,3 @@
 import { Promotion } from '@commercelayer/sdk';
 import { ResourceToProps } from '../types';
-
 export declare const promotionToProps: ResourceToProps<Omit<Promotion, 'type'>>;

package/dist/ui/resources/ResourceListItem/transformers/returns.d.ts

@@ -1,4 +1,3 @@
 import { Return } from '@commercelayer/sdk';
 import { ResourceToProps } from '../types';
-
 export declare const returnToProps: ResourceToProps<Return>;

package/dist/ui/resources/ResourceListItem/transformers/shipments.d.ts

@@ -1,4 +1,3 @@
 import { Shipment } from '@commercelayer/sdk';
 import { ResourceToProps } from '../types';
-
 export declare const shipmentToProps: ResourceToProps<Shipment>;

package/dist/ui/resources/ResourceListItem/transformers/skuListItem.d.ts

@@ -1,4 +1,3 @@
 import { SkuListItem } from '@commercelayer/sdk';
 import { ResourceToProps } from '../types';
-
 export declare const skuListItemToProps: ResourceToProps<SkuListItem>;

package/dist/ui/resources/ResourceListItem/transformers/stockTransfers.d.ts

@@ -1,4 +1,3 @@
 import { StockTransfer } from '@commercelayer/sdk';
 import { ResourceToProps } from '../types';
-
 export declare const stockTransferToProps: ResourceToProps<StockTransfer>;

package/dist/ui/resources/ResourceListItem/types.d.ts

@@ -1,7 +1,6 @@
 import { TokenProviderAuthUser } from '../../../providers/TokenProvider/types';
 import { ListItemProps } from '../../composite/ListItem';
 import { BuyXPayYPromotion, Customer, ExternalPromotion, FixedAmountPromotion, FixedPricePromotion, FreeGiftPromotion, FreeShippingPromotion, Order, PercentageDiscountPromotion, Return, Shipment, SkuListItem, StockTransfer } from '@commercelayer/sdk';
-
 export type ResourceListItemType = Order | Return | Customer | StockTransfer | SkuListItem | Shipment | BuyXPayYPromotion | ExternalPromotion | FixedAmountPromotion | FixedPricePromotion | FreeGiftPromotion | FreeShippingPromotion | PercentageDiscountPromotion;
 export interface ResourceListItemComponentProps {
     name: React.ReactNode;

package/dist/ui/resources/ResourceMetadata/ResourceMetadata.d.ts

@@ -1,6 +1,5 @@
 import { EditMetadataOverlayProps } from '../../../hooks/useEditMetadataOverlay';
 import { ListableResourceType } from '@commercelayer/sdk';
-
 interface MetadataOverlay extends Omit<EditMetadataOverlayProps, 'resourceId' | 'resourceType'> {
 }
 export interface ResourceMetadataProps {

package/dist/ui/resources/ResourceMetadata/ResourceMetadataForm.d.ts

@@ -1,5 +1,4 @@
 import { ResourceMetadataProps } from './ResourceMetadata';
-
 export declare const ResourceMetadataForm: import('../../atoms/SkeletonTemplate').SkeletonTemplateComponent<{
     resourceId: ResourceMetadataProps["resourceId"];
     resourceType: ResourceMetadataProps["resourceType"];

package/dist/ui/resources/ResourceOrderTimeline.d.ts

@@ -1,6 +1,5 @@
 import { referenceOrigins } from '../../helpers/attachments';
 import { Attachment } from '@commercelayer/sdk';
-
 export interface ResourceOrderTimelineProps {
     orderId?: string;
     refresh?: boolean;

package/dist/ui/resources/ResourceShipmentParcels.d.ts

@@ -1,5 +1,4 @@
 import { Shipment as ShipmentResource } from '@commercelayer/sdk';
-
 export interface ResourceShipmentParcelsProps {
     shipment: ShipmentResource;
     onRemoveParcel?: (parcelId: string) => void;

package/dist/ui/resources/ResourceShipmentParcels.mocks.d.ts

@@ -1,5 +1,4 @@
 import { ResourceShipmentParcels } from './ResourceShipmentParcels';
-
 type Shipment = Parameters<typeof ResourceShipmentParcels>[0]['shipment'];
 type Parcel = NonNullable<Shipment['parcels']>[number];
 export declare const parcelWithoutTracking1: import('@commercelayer/sdk').Parcel;

package/dist/ui/resources/ResourceTags.d.ts

@@ -1,6 +1,5 @@
 import { EditTagsOverlayProps } from '../../hooks/useEditTagsOverlay';
 import { ListableResourceType } from '@commercelayer/sdk';
-
 type TaggableResource = Extract<ListableResourceType, 'addresses' | 'bundles' | 'coupons' | 'customers' | 'gift_cards' | 'line_items' | 'line_item_options' | 'order_subscriptions' | 'orders' | 'buy_x_pay_y_promotions' | 'external_promotions' | 'fixed_amount_promotions' | 'fixed_price_promotions' | 'flex_promotions' | 'free_gift_promotions' | 'free_shipping_promotions' | 'percentage_discount_promotions' | 'returns' | 'shipments' | 'sku_options' | 'skus'>;
 interface TagsOverlay extends Omit<EditTagsOverlayProps, 'resourceId' | 'resourceType'> {
 }

package/dist/ui/resources/useResourceFilters/FieldCurrencyRange.d.ts

@@ -1,5 +1,4 @@
 import { FilterItemCurrencyRange } from './types';
-
 interface FieldCurrencyRangeProps {
     item: FilterItemCurrencyRange;
 }

package/dist/ui/resources/useResourceFilters/FieldOptions.d.ts

@@ -1,5 +1,4 @@
 import { FilterItemOptions } from './types';
-
 interface FieldProps {
     item: FilterItemOptions;
 }

package/dist/ui/resources/useResourceFilters/FieldTextSearch.d.ts

@@ -1,5 +1,4 @@
 import { FilterItemTextSearch } from './types';
-
 interface FieldProps {
     item: FilterItemTextSearch;
 }

package/dist/ui/resources/useResourceFilters/FieldTimeRange.d.ts

@@ -1,5 +1,4 @@
 import { FilterItemTime } from './types';
-
 interface FieldTimeRangeProps {
     item: FilterItemTime;
 }

package/dist/ui/resources/useResourceFilters/FiltersForm.d.ts

@@ -1,5 +1,4 @@
 import { FiltersInstructions } from './types';
-
 export interface FiltersFormProps {
     /**
      * Array of instruction items to build the filters behaviors

package/dist/ui/resources/useResourceFilters/FiltersNav.d.ts

@@ -1,5 +1,4 @@
 import { FiltersInstructions } from './types';
-
 export interface FiltersNavProps {
     /**
      * Array of instruction items to build the filters behaviors

package/dist/ui/resources/useResourceFilters/FiltersSearchBar.d.ts

@@ -1,6 +1,5 @@
 import { SearchBarProps } from '../../composite/SearchBar';
 import { FiltersInstructions } from './types';
-
 export interface FilterSearchBarProps extends Pick<SearchBarProps, 'placeholder' | 'debounceMs'> {
     /**
      * Array of instruction items to build the filters behaviors

package/dist/ui/resources/useResourceFilters/adaptFormValuesToSdk.d.ts

@@ -1,6 +1,5 @@
 import { QueryFilter } from '@commercelayer/sdk';
 import { CurrencyRangeFieldValue, FiltersInstructions, UiFilterName, UiFilterValue } from './types';
-
 export interface AdaptFormValuesToSdkParams<FilterFormValues> {
     formValues: FilterFormValues;
     timezone?: string;

package/dist/ui/resources/useResourceFilters/adaptFormValuesToUrlQuery.d.ts

@@ -1,5 +1,4 @@
 import { FiltersInstructions, FormFullValues } from './types';
-
 export interface AdaptFormValuesToUrlQueryParams<FilterFormValues extends FormFullValues> {
     formValues: FilterFormValues;
     instructions: FiltersInstructions;

package/dist/ui/resources/useResourceFilters/adaptSdkToMetrics.d.ts

@@ -1,6 +1,5 @@
 import { FiltersInstructions } from './types';
 import { ListableResourceType, QueryFilter } from '@commercelayer/sdk';
-
 export type CoreResourceEnabledInMetrics = 'orders' | 'returns';
 type MetricsResource = 'order' | 'return';
 /** Record of core api filter operators with relative metrics operator */

package/dist/ui/resources/useResourceFilters/adaptSdkToUrlQuery.d.ts

@@ -1,6 +1,5 @@
 import { FiltersInstructions } from './types';
 import { QueryFilter } from '@commercelayer/sdk';
-
 export interface AdaptSdkToUrlQueryParams {
     sdkFilters: QueryFilter;
     instructions: FiltersInstructions;

package/dist/ui/resources/useResourceFilters/adaptUrlQueryToFormValues.d.ts

@@ -1,5 +1,4 @@
 import { FiltersInstructions, FormFullValues, UiFilterName, UiFilterValue } from './types';
-
 export interface AdaptUrlQueryToFormValuesParams {
     queryString: string;
     instructions: FiltersInstructions;

package/dist/ui/resources/useResourceFilters/adaptUrlQueryToSdk.d.ts

@@ -1,6 +1,5 @@
 import { QueryFilter } from '@commercelayer/sdk';
 import { FiltersInstructions } from './types';
-
 export interface AdaptUrlQueryToSdkParams {
     queryString: string;
     instructions: FiltersInstructions;

package/dist/ui/resources/useResourceFilters/adaptUrlQueryToUrlQuery.d.ts

@@ -1,5 +1,4 @@
 import { FiltersInstructions } from './types';
-
 export interface AdaptUrlQueryToUrlQueryParams {
     queryString: string;
     instructions: FiltersInstructions;

package/dist/ui/resources/useResourceFilters/adapters.d.ts

@@ -1,3 +1,2 @@
 import { MakeFiltersAdapters } from './adapters.types';
-
 export declare const makeFilterAdapters: MakeFiltersAdapters;

package/dist/ui/resources/useResourceFilters/adapters.types.d.ts

@@ -7,7 +7,6 @@ import { AdaptUrlQueryToFormValuesParams } from './adaptUrlQueryToFormValues';
 import { AdaptUrlQueryToSdkParams } from './adaptUrlQueryToSdk';
 import { AdaptUrlQueryToUrlQueryParams } from './adaptUrlQueryToUrlQuery';
 import { FiltersInstructions, FormFullValues, PageInfoFormValues, TimeRangeFormValues, UiFilterName, UiFilterValue } from './types';
-
 interface MakeFilterAdaptersParams {
     instructions: FiltersInstructions;
     predicateWhitelist: string[];

package/dist/ui/resources/useResourceFilters/mockedInstructions.d.ts

@@ -1,3 +1,2 @@
 import { FiltersInstructions } from './types';
-
 export declare const instructions: FiltersInstructions;

package/dist/ui/resources/useResourceFilters/timeUtils.d.ts

@@ -1,6 +1,5 @@
 import { z } from 'zod';
 import { TimeRangeFormValues, TimeRangePreset } from './types';
-
 interface MakerSdkFilterTimeParams {
     timePreset?: TimeRangePreset;
     timeFrom?: Date | null;

package/dist/ui/resources/useResourceFilters/types.d.ts

@@ -1,6 +1,5 @@
 import { InputCurrencyRangeProps } from '../../forms/InputCurrencyRange';
 import { InputResourceGroupProps } from '../../forms/InputResourceGroup';
-
 export declare const filterableTimeRangePreset: readonly ["today", "last7days", "last30days", "custom"];
 export type UiFilterName = string;
 export type UiFilterValue = string | string[] | boolean | Date | undefined;

package/dist/ui/resources/useResourceFilters/useResourceFilters.d.ts

@@ -1,11 +1,10 @@
-import { ResourceListProps } from '../ResourceList';
-import { ResourceListItemTemplate } from '../ResourceList/ResourceList';
+import { UseResourceListConfig } from '../useResourceList';
+import { ResourceListProps } from '../useResourceList/useResourceList';
 import { ListableResourceType, QueryFilter } from '@commercelayer/sdk';
 import { FiltersFormProps } from './FiltersForm';
 import { FiltersNavProps } from './FiltersNav';
 import { makeFilterAdapters } from './adapters';
 import { FiltersInstructions } from './types';
-
 interface UseResourceFiltersConfig {
     /**
      * Array of instruction items to build the filters behaviors
@@ -58,9 +57,9 @@ interface UseResourceFiltersHook {
     /**
      * Filtered ResourceList component based on current active filters
      */
-    FilteredList: <TResource extends ListableResourceType>(props: Omit<ResourceListProps<TResource>, 'query' | 'metricsQuery'> & ResourceListItemTemplate<TResource> & {
-        query?: Omit<NonNullable<ResourceListProps<TResource>['query']>, 'filters'>;
-        metricsQuery?: Omit<NonNullable<ResourceListProps<TResource>['metricsQuery']>, 'filter'> & {
+    FilteredList: <TResource extends ListableResourceType>(props: Omit<UseResourceListConfig<TResource>, 'query' | 'metricsQuery'> & ResourceListProps<TResource> & {
+        query?: Omit<NonNullable<UseResourceListConfig<TResource>['query']>, 'filters'>;
+        metricsQuery?: Omit<NonNullable<UseResourceListConfig<TResource>['metricsQuery']>, 'filter'> & {
             /** Filters need to be configured within the `useResourceFilters` options. */
             filters?: never;
         };

package/dist/ui/resources/useResourceFilters/utils.d.ts

@@ -1,5 +1,4 @@
 import { FilterItemOptions, FiltersInstructions } from './types';
-
 /**
  * Show the filter label with the counter for selected options
  * or just the total of available options when nothing is selected

package/dist/ui/resources/{ResourceList → useResourceList}/VisibilityTrigger.d.ts

@@ -1,5 +1,4 @@
 import { default as React } from 'react';
-
 interface VisibilityTriggerProps extends React.HTMLAttributes<HTMLDivElement> {
     rootMargin?: string;
     callback: (entry: IntersectionObserverEntry) => void;

package/dist/ui/resources/{ResourceList → useResourceList}/adaptMetricsOrderToCore.d.ts

@@ -1,5 +1,4 @@
 import { Order } from '@commercelayer/sdk';
-
 export interface MetricsResourceOrder {
     id: string;
     type: 'orders';

package/dist/ui/resources/useResourceList/index.d.ts

@@ -0,0 +1 @@
+export { useResourceList, type ResourceListItemTemplateProps, type ResourceListProps, type UseResourceListConfig } from './useResourceList';

package/dist/ui/resources/{ResourceList → useResourceList}/infiniteFetcher.d.ts

@@ -1,6 +1,5 @@
-import { MetricsApiClient } from './metricsApiClient';
 import { CommerceLayerClient, ListableResourceType, QueryParamsList, ResourceFields } from '@commercelayer/sdk';
-
+import { MetricsApiClient } from './metricsApiClient';
 type ListResource<TResource extends ListableResourceType> = Awaited<ReturnType<CommerceLayerClient[TResource]['list']>>;
 export type Resource<TResource extends ListableResourceType> = ListResource<TResource>[number];
 export interface FetcherResponse<TResource> {

package/dist/ui/resources/{ResourceList → useResourceList}/metricsApiClient.d.ts

@@ -1,8 +1,7 @@
-import { Resource } from './infiniteFetcher';
 import { MetricsFilters } from '../useResourceFilters/adaptSdkToMetrics';
 import { ListableResourceType, ListMeta, ListResponse } from '@commercelayer/sdk';
 import { Writable } from 'type-fest';
-
+import { Resource } from './infiniteFetcher';
 export type MetricsResources = 'orders' | 'returns';
 type ListResponseWithoutMeta<ResourceType extends MetricsResources> = Omit<ListResponse<Resource<ResourceType>>, 'meta'>;
 type ListMetaWithCursor = Writable<ListMeta> & {

package/dist/ui/resources/{ResourceList → useResourceList}/reducer.d.ts

@@ -1,6 +1,5 @@
 import { ListableResourceType } from '@commercelayer/sdk';
 import { FetcherResponse, Resource } from './infiniteFetcher';
-
 interface ResourceListInternalState<TResource extends ListableResourceType> {
     isLoading: boolean;
     error?: {

package/dist/ui/resources/{ResourceList/ResourceList.d.ts → useResourceList/useResourceList.d.ts}

@@ -1,10 +1,9 @@
 import { SectionProps } from '../../atoms/Section';
 import { SkeletonTemplateProps } from '../../atoms/SkeletonTemplate';
 import { ThProps } from '../../atoms/Table/Th';
-import { FetcherResponse, Resource } from './infiniteFetcher';
-import { ListableResourceType, QueryParamsList, ResourceFields } from '@commercelayer/sdk';
-import { default as React, FC } from 'react';
-
+import { ListMeta, ListableResourceType, QueryParamsList, ResourceFields } from '@commercelayer/sdk';
+import { default as React, FC, ReactNode } from 'react';
+import { Resource } from './infiniteFetcher';
 export interface ResourceListItemTemplateProps<TResource extends ListableResourceType> extends SkeletonTemplateProps<{
     /**
      * The fetched resource
@@ -20,42 +19,20 @@ export interface ResourceListItemTemplateProps<TResource extends ListableResourc
 type TableVariantHeading = Omit<ThProps, 'children'> & {
     label: React.ReactNode;
 };
-export interface ResourceListItemTemplate<TResource extends ListableResourceType> {
+export type ResourceListProps<TResource extends ListableResourceType> = Pick<SectionProps, 'actionButton'> & {
     /**
      * A react component to be used to render each item in the list.
      * For best results, pass as `Item` a component already wrapped in a `SkeletonTemplate` (or `withSkeletonTemplate` HOC).
      * In this way the loading state will be handled automatically.
      */
     ItemTemplate: FC<ResourceListItemTemplateProps<TResource>>;
-}
-export type ResourceListProps<TResource extends ListableResourceType> = Pick<SectionProps, 'actionButton'> & {
-    /**
-     * The resource type to be fetched in the list
-     */
-    type: TResource;
-    /**
-     * SDK query object to be used to fetch the list, excluding the pageNumber that is handled internally for infinite scrolling.
-     */
-    query?: Omit<QueryParamsList<ResourceFields[TResource]>, 'pageNumber'>;
-    /**
-     * When set the component will fetch data from the Metrics API, and automatically use the returned cursor for infinite scrolling.
-     */
-    metricsQuery?: {
-        search: {
-            limit?: number;
-            sort?: 'asc' | 'desc';
-            sort_by?: string;
-            fields?: string[];
-        };
-        filter: Record<string, unknown>;
-    };
     /**
      * An element to be rendered when the list is empty.
      * When not provided, a default message will be shown.
      * When a string is provided, it will be rendered as inline text below title and actionButton.
-     * When a JSX element is provided, it will be rendered as a custom element and no title or actionButton will be shown.
+     * When other ReactNode is provided, it will be rendered as a custom element and no title or actionButton will be shown.
      */
-    emptyState?: JSX.Element;
+    emptyState?: ReactNode;
     /**
      * Title.
      */
@@ -68,32 +45,60 @@ export type ResourceListProps<TResource extends ListableResourceType> = Pick<Sec
     /** Boxed variant wraps the list in a Card */
     variant?: 'boxed';
 } | {
+    /** Table variant wraps the list in a Table and enables the `headings` prop */
     variant: 'table';
     headings: TableVariantHeading[];
-}) & (ResourceListItemTemplate<TResource> | {
+});
+export interface UseResourceListConfig<TResource extends ListableResourceType> {
     /**
-     * Children as a function to render a custom element.
-     * @example
-     * ```
-     * <ResourceList type='customers'>
-     *  {({ isLoading, data }) => <ol>{data?.list.map(customer => <li>{customer.email}</li>)}</ol>
-     * </ResourceList>
-     * ```
+     * The resource type to be fetched in the list
      */
-    children: (childrenProps: {
-        isLoading: boolean;
-        data?: FetcherResponse<Resource<TResource>>;
-        isFirstLoading: boolean;
-        removeItem: (resourceId: string) => void;
-    }) => React.ReactNode;
-});
+    type: TResource;
+    /**
+     * SDK query object to be used to fetch the list, excluding the pageNumber that is handled internally for infinite scrolling.
+     */
+    query?: Omit<QueryParamsList<ResourceFields[TResource]>, 'pageNumber'>;
+    /**
+     * When set the component will fetch data from the Metrics API, and automatically use the returned cursor for infinite scrolling.
+     */
+    metricsQuery?: {
+        search: {
+            limit?: number;
+            sort?: 'asc' | 'desc';
+            sort_by?: string;
+            fields?: string[];
+        };
+        filter: Record<string, unknown>;
+    };
+}
 /**
  * Renders a list of resources of a given type with infinite scrolling.
  * It's possible to specify a query to filter the list and either
  * a React component (`ItemTemplate`) to be used as item template for the list or a function as `children` to render a custom element.
  */
-export declare function ResourceList<TResource extends ListableResourceType>({ type, query, title, titleSize, variant, actionButton, metricsQuery, emptyState: emptyStateProp, ...props }: ResourceListProps<TResource>): JSX.Element;
-export declare namespace ResourceList {
-    var displayName: string;
-}
+export declare function useResourceList<TResource extends ListableResourceType>({ type, query, metricsQuery }: UseResourceListConfig<TResource>): {
+    /** The component that renders the list with infinite scrolling functionality */
+    ResourceList: FC<ResourceListProps<TResource>>;
+    /** The raw array of fetched resources, which grows each time a new page is fetched */
+    list?: Array<Resource<TResource>>;
+    /** Metadata related to pagination, as returned by the SDK */
+    meta?: ListMeta;
+    /** Indicates whether the list is currently loading the next page */
+    isLoading: boolean;
+    /** Indicates whether the list is loading for the first time (initial page load) */
+    isFirstLoading: boolean;
+    /** The error message (already parsed) returned from the API when a fetch request fails */
+    error?: string;
+    /** Removes an item from the list, typically can be triggered after a delete action from the UI */
+    removeItem: (resourceId: string) => void;
+    /**
+     * Manually triggers data fetching for the next page without requiring the user to reach the infinite scroll trigger.
+     * It does not trigger when last page has been reached.
+     */
+    fetchMore: () => Promise<void>;
+    /** Refreshes the list by clearing all previously fetched data and resetting the initial loading state before refetching the first page. */
+    refresh: () => void;
+    /** Indicates whether there are more pages available for fetching */
+    hasMorePages?: boolean;
+};
 export {};

package/dist/utils/children.d.ts

@@ -1,5 +1,4 @@
 import { ReactElement, ReactNode } from 'react';
-
 export declare function isFunctionComponent(reactNode: ReactNode): reactNode is ReactElement<any, React.FunctionComponent<any>>;
 /**
  * Checks if a ReactNode matches a specific component display name.

package/dist/utils/extractHeaders.d.ts

@@ -1,5 +1,4 @@
 import { JsonObject } from 'type-fest';
-
 /**
  * Extract all keys from an array of objects of different shapes,
  * @param data - array of objects of different shapes

package/dist/utils/text.d.ts

@@ -1,5 +1,4 @@
 import { JsonPrimitive } from 'type-fest';
-
 /**
  * Given a `text` and a list of `values` it returns always the same value given the same `text`.
  * For example this is used when you need to map a full name with a color.