@mittwald/flow-react-components 0.1.0-alpha.42 → 0.1.0-alpha.44

package/dist/types/components/Heading/stories/Default.stories.d.ts

@@ -4,3 +4,4 @@ declare const meta: Meta<typeof Heading>;
 export default meta;
 type Story = StoryObj<typeof Heading>;
 export declare const Default: Story;
+export declare const WithIcon: Story;

package/dist/types/components/Heading/stories/EdgeCases.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import Heading from "../Heading";
+declare const meta: Meta<typeof Heading>;
+export default meta;
+type Story = StoryObj<typeof Heading>;
+export declare const LongText: Story;

package/dist/types/components/List/List.d.ts

@@ -0,0 +1,7 @@
+import React, { PropsWithChildren } from "react";
+import { AnyData } from './model/item/types';
+import { ListShape } from './model/types';
+interface Props extends PropsWithChildren, Pick<ListShape<AnyData>, "enableMultiSort"> {
+}
+export declare function List(props: Props): React.JSX.Element;
+export default List;

package/dist/types/components/List/List.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/components/List/components/DataLoader/DataLoader.d.ts

@@ -0,0 +1,3 @@
+import React from "react";
+export declare const DataLoader: () => React.JSX.Element[];
+export default DataLoader;

package/dist/types/components/List/components/DataLoader/components/SuspenseFallback/SuspenseFallback.d.ts

@@ -0,0 +1,6 @@
+import { FC } from "react";
+interface Props {
+    pageIndex: number;
+}
+export declare const SuspenseFallback: FC<Props>;
+export default SuspenseFallback;

package/dist/types/components/List/components/DataLoader/components/SuspenseFallback/index.d.ts

@@ -0,0 +1,3 @@
+import { SuspenseFallback } from "./SuspenseFallback";
+export { SuspenseFallback } from "./SuspenseFallback";
+export default SuspenseFallback;

package/dist/types/components/List/components/DataLoader/index.d.ts

@@ -0,0 +1,3 @@
+import { DataLoader } from "./DataLoader";
+export { DataLoader } from "./DataLoader";
+export default DataLoader;

package/dist/types/components/List/components/FilterBar/FilterBar.d.ts

@@ -0,0 +1,6 @@
+import { FC } from "react";
+interface Props {
+    className?: string;
+}
+export declare const FilterBar: FC<Props>;
+export default FilterBar;

package/dist/types/components/List/components/FilterBar/components/FilterPicker/FilterPicker.d.ts

@@ -0,0 +1,2 @@
+import { FC } from "react";
+export declare const FilterPicker: FC;

package/dist/types/components/List/components/FilterBar/components/FilterPicker/index.d.ts

@@ -0,0 +1,3 @@
+import { FilterPicker } from "./FilterPicker";
+export { FilterPicker } from "./FilterPicker";
+export default FilterPicker;

package/dist/types/components/List/components/FilterBar/components/FilterPickerItem/FilterPickerItem.d.ts

@@ -0,0 +1,8 @@
+import { FC } from "react";
+import { Filter } from '../../../../model/filter/Filter';
+import { AnyData } from '../../../../model/item/types';
+interface Props {
+    filter: Filter<AnyData>;
+}
+export declare const FilterPickerItem: FC<Props>;
+export {};

package/dist/types/components/List/components/FilterBar/components/FilterPickerItem/index.d.ts

@@ -0,0 +1,3 @@
+import { FilterPickerItem } from "./FilterPickerItem";
+export { FilterPickerItem } from "./FilterPickerItem";
+export default FilterPickerItem;

package/dist/types/components/List/components/FilterBar/components/SortingPicker/SortingPicker.d.ts

@@ -0,0 +1,2 @@
+import { FC } from "react";
+export declare const SortingPicker: FC;

package/dist/types/components/List/components/FilterBar/components/SortingPicker/index.d.ts

@@ -0,0 +1,3 @@
+import { SortingPicker } from "./SortingPicker";
+export { SortingPicker } from "./SortingPicker";
+export default SortingPicker;

package/dist/types/components/List/components/FilterBar/components/SortingPickerItem/SortingPickerItem.d.ts

@@ -0,0 +1,8 @@
+import { FC } from "react";
+import { AnyData } from '../../../../model/item/types';
+import { Sorting } from '../../../../model/sorting/Sorting';
+interface Props {
+    sorting: Sorting<AnyData>;
+}
+export declare const SortingPickerItem: FC<Props>;
+export {};

package/dist/types/components/List/components/FilterBar/components/SortingPickerItem/index.d.ts

@@ -0,0 +1,3 @@
+import { SortingPickerItem } from "./SortingPickerItem";
+export { SortingPickerItem } from "./SortingPickerItem";
+export default SortingPickerItem;

package/dist/types/components/List/components/FilterBar/index.d.ts

@@ -0,0 +1,3 @@
+import { FilterBar } from "./FilterBar";
+export { FilterBar } from "./FilterBar";
+export default FilterBar;

package/dist/types/components/List/components/Item/FallbackRenderer.d.ts

@@ -0,0 +1,7 @@
+import { AnyData } from '../../model/item/types';
+import { FC } from "react";
+interface Props {
+    data: AnyData;
+}
+export declare const FallbackRenderer: FC<Props>;
+export {};

package/dist/types/components/List/components/Item/Item.d.ts

@@ -0,0 +1,5 @@
+import React, { PropsWithChildren } from "react";
+interface Props extends PropsWithChildren {
+}
+export declare const Item: (props: Props) => React.JSX.Element;
+export default Item;

package/dist/types/components/List/components/Item/index.d.ts

@@ -0,0 +1,3 @@
+import { Item } from "./Item";
+export { Item } from "./Item";
+export default Item;

package/dist/types/components/List/components/Items/Items.d.ts

@@ -0,0 +1,6 @@
+import { FC } from "react";
+interface Props {
+    className?: string;
+}
+export declare const Items: FC<Props>;
+export default Items;

package/dist/types/components/List/components/Items/index.d.ts

@@ -0,0 +1,3 @@
+import { Items } from "./Items";
+export { Items } from "./Items";
+export default Items;

package/dist/types/components/List/components/ListFilter.d.ts

@@ -0,0 +1,5 @@
+import { FilterShape } from '../model/filter/types';
+interface Props<T> extends Omit<FilterShape<T>, "type"> {
+}
+export declare function ListFilter<T = never>(ignoredProps: Props<T>): null;
+export {};

package/dist/types/components/List/components/ListItemView.d.ts

@@ -0,0 +1,6 @@
+import { RenderItemFn } from '../model/item/Item';
+interface Props<T> {
+    children: RenderItemFn<T>;
+}
+export declare function ListItemView<T = never>(ignoredProps: Props<T>): null;
+export {};

package/dist/types/components/List/components/ListLoaderAsync.d.ts

@@ -0,0 +1,6 @@
+import { AsyncDataLoaderShape } from '../model/loading/types';
+interface Props<T> extends Omit<AsyncDataLoaderShape<T>, "asyncLoader"> {
+    children: AsyncDataLoaderShape<T>["asyncLoader"];
+}
+export declare function ListLoaderAsync<T = never>(ignoredProps: Props<T>): null;
+export {};

package/dist/types/components/List/components/ListLoaderAsyncResource.d.ts

@@ -0,0 +1,6 @@
+import { AsyncResourceFactoryDataLoaderShape } from '../model/loading/types';
+interface Props<T> extends Omit<AsyncResourceFactoryDataLoaderShape<T>, "asyncResourceFactory"> {
+    children: AsyncResourceFactoryDataLoaderShape<T>["asyncResourceFactory"];
+}
+export declare function ListLoaderAsyncResource<T = never>(ignoredProps: Props<T>): null;
+export {};

package/dist/types/components/List/components/ListSorting.d.ts

@@ -0,0 +1,5 @@
+import { SortingShape } from '../model/sorting/types';
+interface Props<T> extends SortingShape<T> {
+}
+export declare function ListSorting<T = never>(ignoredProps: Props<T>): null;
+export {};

package/dist/types/components/List/components/ListStaticData.d.ts

@@ -0,0 +1,5 @@
+interface Props<T> {
+    data: T[];
+}
+export declare function ListStaticData<T = never>(ignoredProps: Props<T>): null;
+export {};

package/dist/types/components/List/components/PaginationInfos/PaginationInfos.d.ts

@@ -0,0 +1,4 @@
+import { TextProps } from '../../../Text';
+import { FC } from "react";
+export declare const PaginationInfos: FC<TextProps>;
+export default PaginationInfos;

package/dist/types/components/List/components/PaginationInfos/index.d.ts

@@ -0,0 +1,3 @@
+import { PaginationInfos } from "./PaginationInfos";
+export { PaginationInfos } from "./PaginationInfos";
+export default PaginationInfos;

package/dist/types/components/List/components/ShowMoreItemsButton/ShowMoreItemsButton.d.ts

@@ -0,0 +1,4 @@
+import { FC } from "react";
+import { ButtonProps } from '../../../Button';
+export declare const ShowMoreItemsButton: FC<ButtonProps>;
+export default ShowMoreItemsButton;

package/dist/types/components/List/components/ShowMoreItemsButton/index.d.ts

@@ -0,0 +1,3 @@
+import { ShowMoreItemsButton } from "./ShowMoreItemsButton";
+export { ShowMoreItemsButton } from "./ShowMoreItemsButton";
+export default ShowMoreItemsButton;

package/dist/types/components/List/hooks/useList.d.ts

@@ -0,0 +1 @@
+export declare const useList: () => import("../model/List").List<any>;

package/dist/types/components/List/index.d.ts

@@ -0,0 +1,8 @@
+import { List } from "./List";
+export * from "./List";
+export * from "./components/ListFilter";
+export * from "./components/ListSorting";
+export * from "./components/ListItemView";
+export * from "./components/ListLoaderAsync";
+export * from "./components/ListStaticData";
+export default List;

package/dist/types/components/List/listContext.d.ts

@@ -0,0 +1,8 @@
+/// <reference types="react" />
+import List from './model/List';
+import { AnyData } from './model/item/types';
+interface ListContext {
+    list: List<AnyData>;
+}
+export declare const listContext: import("react").Context<ListContext>;
+export {};

package/dist/types/components/List/model/List.d.ts

@@ -0,0 +1,21 @@
+import { ItemCollection } from './item/ItemCollection';
+import { Pagination } from './pagination/Pagination';
+import { RenderItemFn } from './item/Item';
+import { Filter } from "./filter/Filter";
+import { Sorting } from './sorting/Sorting';
+import ReactTable from './ReactTable';
+import { ListShape } from './types';
+import { IncrementalLoader } from './loading/IncrementalLoader';
+export declare class List<T> {
+    readonly filters: Array<Filter<T>>;
+    readonly sorting: Array<Sorting<T>>;
+    readonly items: ItemCollection<T>;
+    readonly render?: RenderItemFn<T>;
+    readonly reactTable: ReactTable<T>;
+    readonly pagination: Pagination<T>;
+    readonly loader: IncrementalLoader<T>;
+    private constructor();
+    static useNew<T>(shape: ListShape<T>): List<T>;
+    isFiltered(): boolean;
+}
+export default List;

package/dist/types/components/List/model/ReactTable.d.ts

@@ -0,0 +1,17 @@
+import { Column, Table, TableOptions } from "@tanstack/react-table";
+import List from './List';
+import { PropertyName } from './item/Item';
+export declare class ReactTable<T> {
+    readonly list: List<T>;
+    readonly table: Table<T>;
+    private readonly tableState;
+    private constructor();
+    static useNew<T>(list: List<T>, tableOptions?: Partial<TableOptions<T>>): ReactTable<T>;
+    private useReactTable;
+    private useUpdateTableState;
+    private onTableStateChange;
+    private getUpdatedTableState;
+    getTableColumn(property: PropertyName<T>): Column<T>;
+    private getTableColumnDefs;
+}
+export default ReactTable;

package/dist/types/components/List/model/filter/Filter.d.ts

@@ -0,0 +1,26 @@
+import { Column, ColumnDef, ColumnFilter } from "@tanstack/react-table";
+import List from '../List';
+import { PropertyName } from '../item/Item';
+import { FilterMatcher, FilterMode, FilterShape } from './types';
+export declare class Filter<T> {
+    private readonly _values?;
+    readonly list: List<T>;
+    readonly property: PropertyName<T>;
+    readonly mode: FilterMode;
+    readonly matcher: FilterMatcher;
+    private onFilterUpdateCallbacks;
+    constructor(list: List<T>, shape: FilterShape<T>);
+    updateTableColumnDef(def: ColumnDef<T>): void;
+    private getReactTableFilterFn;
+    private checkFilterMatches;
+    protected getTableColumnFilter(): ColumnFilter | undefined;
+    protected getTableColumn(): Column<T>;
+    getValue(): unknown;
+    getValueId(value: unknown): string;
+    get values(): unknown[];
+    getArrayValue(): Array<unknown>;
+    isValueActive(value: unknown): boolean;
+    isActive(): boolean;
+    toggleValue(newValue: unknown): void;
+    onFilterUpdated(cb: () => unknown): void;
+}

package/dist/types/components/List/model/filter/types.d.ts

@@ -0,0 +1,9 @@
+import { PropertyName } from '../item/Item';
+export type FilterMode = "all" | "some" | "one";
+export type FilterMatcher = (filterValue: unknown, property: unknown) => boolean;
+export interface FilterShape<T> {
+    property: PropertyName<T>;
+    mode?: FilterMode;
+    matcher?: FilterMatcher;
+    values?: unknown[];
+}

package/dist/types/components/List/model/item/Item.d.ts

@@ -0,0 +1,14 @@
+import { ItemCollection } from './ItemCollection';
+import { ReactNode } from "react";
+import { DeepKeys, Row } from "@tanstack/react-table";
+export type PropertyName<T> = DeepKeys<T>;
+export type RenderItemFn<T> = (data: T) => ReactNode;
+export declare class Item<T> {
+    readonly id: string;
+    readonly data: T;
+    readonly collection: ItemCollection<T>;
+    constructor(collection: ItemCollection<T>, id: string, data: T);
+    render(): ReactNode;
+    static fromRow<T>(collection: ItemCollection<T>, row: Row<T>): Item<T>;
+    private static fallbackRenderItemFn;
+}

package/dist/types/components/List/model/item/ItemCollection.d.ts

@@ -0,0 +1,8 @@
+import List from '../List';
+import { Item } from './Item';
+export declare class ItemCollection<T> {
+    readonly list: List<T>;
+    private constructor();
+    static useNew<T>(list: List<T>): ItemCollection<T>;
+    get entries(): Item<T>[];
+}

package/dist/types/components/List/model/item/types.d.ts

@@ -0,0 +1,5 @@
+export type AnyData = any;
+export interface ListDataLoaderResult<T> {
+    data: T[];
+    itemTotalCount?: number;
+}

package/dist/types/components/List/model/loading/IncrementalLoader.d.ts

@@ -0,0 +1,23 @@
+import List from '../List';
+import { IncrementalLoaderShape } from './types';
+export declare class IncrementalLoader<T> {
+    private readonly list;
+    private readonly dataSource;
+    private readonly pagesDataSignal;
+    private readonly pagesLoadingStateSignal;
+    readonly manualSorting: boolean;
+    readonly manualFiltering: boolean;
+    readonly manualPagination: boolean;
+    constructor(list: List<T>, shape?: IncrementalLoaderShape<T>);
+    private reset;
+    useIsLoading(): boolean;
+    useData(): T[];
+    useSuspenseHook(pageIndex: number): void;
+    getLoaderInvocationHooks(): Array<() => void>;
+    private useLoadPage;
+    private getDataLoaderOptions;
+    private getPageDataAsyncResource;
+    private updatePageData;
+    private updatePageLoadingState;
+    loadMore(): void;
+}

package/dist/types/components/List/model/loading/types.d.ts

@@ -0,0 +1,43 @@
+import { PropertyRecord } from '../types';
+import { FilterMode } from '../filter/types';
+import { AsyncResource } from "@mittwald/react-use-promise";
+type DataLoaderSortOptions<T> = PropertyRecord<T, "asc" | "desc">;
+type DataLoaderFilterOptions<T> = PropertyRecord<T, {
+    mode: FilterMode;
+    values: unknown[];
+}>;
+interface DataLoaderPaginationOptions {
+    offset: number;
+    limit: number;
+}
+export interface DataLoaderOptions<T> {
+    sorting?: DataLoaderSortOptions<T>;
+    filtering?: DataLoaderFilterOptions<T>;
+    pagination?: DataLoaderPaginationOptions;
+}
+export type DataLoaderResult<T> = {
+    data: T[];
+    itemTotalCount?: number;
+};
+export type AsyncDataLoader<T> = (options?: DataLoaderOptions<T>) => Promise<DataLoaderResult<T>>;
+type AsyncResourceFactory<T> = (options?: DataLoaderOptions<T>) => AsyncResource<DataLoaderResult<T>>;
+type StaticData<T> = T[];
+interface DynamicLoaderShape {
+    manualSorting?: boolean;
+    manualFiltering?: boolean;
+    manualPagination?: boolean;
+}
+export interface StaticDataLoaderShape<T> {
+    staticData: StaticData<T>;
+}
+export type AsyncResourceFactoryDataLoaderShape<T> = {
+    asyncResourceFactory: AsyncResourceFactory<T>;
+} & DynamicLoaderShape;
+export type AsyncDataLoaderShape<T> = {
+    asyncLoader: AsyncDataLoader<T>;
+} & DynamicLoaderShape;
+export type DataSource<T> = StaticDataLoaderShape<T> | AsyncResourceFactoryDataLoaderShape<T> | AsyncDataLoaderShape<T>;
+export interface IncrementalLoaderShape<T> {
+    source?: DataSource<T>;
+}
+export {};

package/dist/types/components/List/model/pagination/Pagination.d.ts

@@ -0,0 +1,16 @@
+import List from '../List';
+import { PaginationShape } from './types';
+export declare class Pagination<T> {
+    private readonly list;
+    readonly initialPageSize: number;
+    constructor(list: List<T>, shape?: PaginationShape);
+    getPageIndex(): number;
+    hasNextPage(): boolean;
+    nextPage(): void;
+    updatePageSize(size: number): void;
+    getPageSize(): number;
+    getTotalItemsCount(): number | undefined;
+    getFilteredItemsCount(): number;
+    getVisibleItemsCount(): number | undefined;
+    updateItemTotalCount(value: number): void;
+}

package/dist/types/components/List/model/pagination/types.d.ts

@@ -0,0 +1,3 @@
+export interface PaginationShape {
+    pageSize?: number;
+}

package/dist/types/components/List/model/sorting/Sorting.d.ts

@@ -0,0 +1,12 @@
+import { Column, ColumnDef, SortDirection } from "@tanstack/react-table";
+import List from '../List';
+import { PropertyName } from '../item/Item';
+import { SortingShape } from './types';
+export declare class Sorting<T> {
+    readonly list: List<T>;
+    readonly property: PropertyName<T>;
+    constructor(list: List<T>, shape: SortingShape<T>);
+    updateTableColumnDef(def: ColumnDef<T>): void;
+    get direction(): SortDirection | false;
+    getTableColumn(): Column<T>;
+}

package/dist/types/components/List/model/sorting/types.d.ts

@@ -0,0 +1,4 @@
+import { PropertyName } from '../item/Item';
+export interface SortingShape<T> {
+    property: PropertyName<T>;
+}

package/dist/types/components/List/model/types.d.ts

@@ -0,0 +1,14 @@
+import { PropertyName, RenderItemFn } from './item/Item';
+import { SortingShape } from './sorting/types';
+import { PaginationShape } from './pagination/types';
+import { FilterShape } from './filter/types';
+import { IncrementalLoaderShape } from './loading/types';
+export interface ListShape<T> {
+    loader?: IncrementalLoaderShape<T>;
+    render?: RenderItemFn<T>;
+    filters?: FilterShape<T>[];
+    sorting?: SortingShape<T>[];
+    pagination?: PaginationShape;
+    enableMultiSort?: boolean;
+}
+export type PropertyRecord<T, TValue> = Partial<Record<PropertyName<T>, TValue>>;

package/dist/types/components/List/stories/Default.stories.d.ts

@@ -0,0 +1,6 @@
+import type { Meta, StoryObj } from "@storybook/react";
+import List from "../List";
+declare const meta: Meta<typeof List>;
+export default meta;
+type Story = StoryObj<typeof List>;
+export declare const Default: Story;

package/dist/types/components/List/testData/userApi.d.ts

@@ -0,0 +1,57 @@
+export type User = (typeof users)[number];
+export declare const getStates: () => Promise<string[]>;
+interface Request {
+    pagination?: {
+        limit: number;
+        skip: number;
+    };
+    filter?: {
+        states?: string[];
+    };
+}
+interface Response {
+    data: User[];
+    totalCount: number;
+}
+export declare const getUsers: (req: Request) => Promise<Response>;
+export declare const users: {
+    status: string;
+    name: {
+        first: string;
+        middle: string;
+        last: string;
+    };
+    username: string;
+    password: string;
+    emails: string[];
+    phoneNumber: string;
+    location: {
+        street: string;
+        city: string;
+        state: string;
+        country: string;
+        zip: string;
+        coordinates: {
+            latitude: number;
+            longitude: number;
+        };
+    };
+    website: string;
+    domain: string;
+    job: {
+        title: string;
+        descriptor: string;
+        area: string;
+        type: string;
+        company: string;
+    };
+    creditCard: {
+        number: string;
+        cvv: string;
+        issuer: string;
+    };
+    uuid: string;
+    objectId: string;
+}[];
+export declare const states: string[];
+export {};

package/dist/types/lib/react/components/Empty/Empty.d.ts

@@ -0,0 +1,3 @@
+import { FC } from "react";
+export declare const Empty: FC<any>;
+export default Empty;

package/dist/types/lib/react/components/Empty/index.d.ts

@@ -0,0 +1,3 @@
+import { Empty } from "./Empty";
+export { Empty } from "./Empty";
+export default Empty;

package/dist/types/lib/react/components/Render/Render.d.ts

@@ -0,0 +1,4 @@
+import { FC, ReactNode } from "react";
+export declare const Render: FC<{
+    children: () => ReactNode | void;
+}>;

package/dist/types/lib/react/components/Render/Render.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/react/components/Render/index.d.ts

@@ -0,0 +1 @@
+export * from "./Render";

package/dist/types/lib/react/deepFindOfType.d.ts

@@ -0,0 +1,3 @@
+import { ComponentProps, ElementType, FunctionComponentElement, ReactNode } from "react";
+export declare const deepFindOfType: <T extends ElementType>(children: ReactNode, searchType: T) => FunctionComponentElement<ComponentProps<T>> | undefined;
+export declare const deepFilterByType: <T extends ElementType>(children: ReactNode, searchType: T) => Array<FunctionComponentElement<ComponentProps<T>>>;

package/dist/types/lib/react/deepFindOfType.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/lib/react/deepHas.d.ts

@@ -0,0 +1,2 @@
+import { ElementType, ReactNode } from "react";
+export declare const deepHas: (children: ReactNode | ReactNode[], searchType: ElementType) => boolean;