@hitgrab/finder 0.0.26-alpha → 0.1.0-alpha

package/dist/types.d.ts

@@ -1,221 +0,0 @@
-/**
- * Public types that are necessary to use the library.
- */
-import { readonlyFiltersInterface } from "./core/filters/filters-interface";
-import { readonlyGroupByInterface } from "./core/group-by/group-by-interface";
-import { metaInterface, readonlyMetaInterface } from "./core/meta/meta-interface";
-import { readonlySearchInterface } from "./core/search/search-interface";
-import { readonlySelectedItemsInterface } from "./core/selected-items/selected-items-interface";
-import { readonlySortByInterface } from "./core/sort-by/sort-by-interface";
-import { readonlyLayoutInterface } from "./core/layout/layout-interface";
-import { FinderCore } from "./core/finder-core";
-export type MetaInterface = ReturnType<typeof metaInterface>;
-export interface FinderConstructorOptions<FItem> {
-    rules?: FinderRule<FItem>[];
-    initialSearchTerm?: string;
-    initialSortBy?: string;
-    initialSortDirection?: SortDirection;
-    initialGroupBy?: string;
-    initialFilters?: Record<string, any>;
-    initialMeta?: Record<string, any>;
-    initialSelectedItems?: FItem[];
-    maxSelectedItems?: number;
-    isLoading?: boolean;
-    disabled?: boolean;
-    page?: number;
-    numItemsPerPage?: number;
-    requireGroup?: boolean;
-    plugins?: (FinderPluginInterface | FinderPluginFn<FinderPluginInterface>)[];
-    layoutVariants?: LayoutVariant[];
-    initialLayout?: string;
-    onInit?: FinderOnInitCallback;
-    onReady?: FinderOnReadyCallback;
-    onFirstUserInteraction?: FinderOnFirstUserInteractCallback;
-    onChange?: FinderOnChangeCallback;
-}
-export interface FinderResultGroup<FItem> {
-    id: string;
-    items: FItem[];
-}
-export type FinderRule<FItem = any> = SearchRule<FItem> | FilterRuleUnion<FItem> | HydratedFilterRule<FItem> | SortByRule<FItem> | GroupByRule<FItem>;
-export interface SearchRuleSharedProps {
-    id?: string;
-    label?: string;
-    hidden?: boolean;
-    debounceMilliseconds?: number;
-    searchFn?: unknown;
-    searchTermFn?: unknown;
-}
-export interface SearchRuleSimple<FItem = any> extends SearchRuleSharedProps {
-    searchFn?: never;
-    searchTermFn: (item: FItem, meta: MetaInterface) => string | string[];
-}
-export interface SearchRuleAdvanced<FItem = any> extends SearchRuleSharedProps {
-    searchTermFn?: never;
-    searchFn: (item: FItem, searchTerm: string, meta: MetaInterface) => boolean;
-}
-export type SearchRule<FItem = any> = SearchRuleAdvanced<FItem> | SearchRuleSimple<FItem>;
-export interface FilterOptionGeneratorFnOptions<FItem> {
-    items: FItem[];
-    meta: MetaInterface;
-}
-export interface FilterRule<FItem = any, FValue = any> {
-    id: string;
-    options?: FilterOption<FValue>[] | ((options: FilterOptionGeneratorFnOptions<FItem>) => FilterOption<FValue>[]);
-    required?: boolean;
-    label?: string;
-    hidden?: boolean;
-    debounceMilliseconds?: number;
-    multiple?: boolean;
-    isBoolean?: boolean;
-    filterFn: CallableFunction;
-    defaultValue?: any;
-}
-interface FilterRuleWithBooleanValue<FItem, FValue = boolean> extends FilterRule<FItem, FValue> {
-    multiple?: false;
-    isBoolean: true;
-    filterFn: (item: FItem, value: FValue, meta: MetaInterface) => boolean;
-    defaultValue?: boolean;
-}
-interface FilterRuleWithScalarValue<FItem, FValue> extends FilterRule<FItem, FValue> {
-    multiple?: false;
-    isBoolean?: false;
-    filterFn: (item: FItem, value: FValue, meta: MetaInterface) => boolean;
-    defaultValue?: FValue;
-}
-interface FilterRuleWithMultipleValues<FItem, FValue> extends FilterRule<FItem, FValue> {
-    multiple: true;
-    isBoolean?: false;
-    filterFn: (item: FItem, value: FValue[], meta: MetaInterface) => boolean;
-    defaultValue?: FValue[];
-}
-export type FilterRuleUnion<FItem = any, FValue = any> = FilterRuleWithBooleanValue<FItem> | FilterRuleWithScalarValue<FItem, FValue> | FilterRuleWithMultipleValues<FItem, FValue>;
-/**
- * A hydrated filter has rendered any option generator functions, and narrowed uncertain properties from FilterRule.
- */
-export interface HydratedFilterRule<FItem = any, FValue = any> extends Omit<FilterRule<FItem, FValue>, "options" | "required" | "isBoolean" | "hidden"> {
-    options?: FilterOption<FValue>[];
-    required: boolean;
-    isBoolean: boolean;
-    hidden: boolean;
-    multiple: boolean;
-    filterFn: ((item: FItem, value: FValue, meta: MetaInterface) => boolean) | ((item: FItem, value: FValue[], meta: MetaInterface) => boolean);
-    defaultValue?: boolean | FValue | FValue[];
-    _isHydrated: true;
-}
-export interface GroupByRule<FItem = any> {
-    id: string;
-    groupFn: FinderPropertySelector<FItem>;
-    sortGroupIdFn?: FinderPropertySelector<FinderResultGroup<FItem>>;
-    groupIdSortDirection?: SortDirection;
-    sticky?: {
-        header?: string | string[];
-        footer?: string | string[];
-    };
-    label?: string;
-    hidden?: boolean;
-}
-export interface SortByRule<FItem = any> {
-    id: string;
-    sortFn: FinderPropertySelector<FItem> | FinderPropertySelector<FItem>[];
-    defaultSortDirection?: SortDirection;
-    label?: string;
-    hidden?: boolean;
-}
-export type SortDirection = "asc" | "desc" | ("asc" | "desc")[];
-/**
- * Select a property from the item to sort by.
- */
-export type FinderPropertySelector<FItem> = (item: FItem, meta: MetaInterface) => string | number;
-/**
- * Describes the display of a filter or sort option.
- */
-export interface FilterOption<FValue = any> {
-    label: string;
-    value: FValue;
-    disabled?: boolean;
-}
-export interface MatchesSnapshot<FItem> {
-    items?: FItem[];
-    groups?: FinderResultGroup<FItem>[];
-    numMatchedItems: number;
-    numTotalItems: number;
-    hasGroupByRule: boolean;
-}
-export interface FilterTestOptions {
-    rules?: HydratedFilterRule[];
-    values?: any;
-    meta?: MetaInterface;
-    isAdditive?: boolean;
-}
-export interface FilterTestRuleOptions {
-    rule: string | FilterRuleUnion | HydratedFilterRule;
-    value: any;
-    meta?: MetaInterface;
-    isAdditive?: boolean;
-}
-export interface FilterTestRuleOptionsOptions {
-    rule: string | FilterRuleUnion | HydratedFilterRule;
-    meta?: MetaInterface;
-    isAdditive?: boolean;
-    mergeExistingValue?: boolean;
-}
-export interface FinderSnapshot<FItem> {
-    search: ReturnType<typeof readonlySearchInterface<FItem>>;
-    filters: ReturnType<typeof readonlyFiltersInterface>;
-    sortBy: ReturnType<typeof readonlySortByInterface<FItem>>;
-    groupBy: ReturnType<typeof readonlyGroupByInterface<FItem>>;
-    selectedItems: ReturnType<typeof readonlySelectedItemsInterface<FItem>>;
-    layout: ReturnType<typeof readonlyLayoutInterface>;
-    meta: ReturnType<typeof readonlyMetaInterface<FItem>>;
-    updatedAt: number | undefined;
-}
-export type FinderTouchSource = "core" | "filters" | "groupBy" | "meta" | "pagination" | "search" | "selectedItems" | "sortBy" | "plugin" | "layout";
-type FinderSharedEventProps = {
-    source: string;
-    event: FinderEventName;
-    snapshot: FinderSnapshot<any>;
-    timestamp: number;
-};
-export interface FinderInitEvent extends FinderSharedEventProps {
-    source: "core";
-    event: "init";
-}
-export interface FinderFirstUserInteractionEvent extends FinderSharedEventProps {
-    source: "core";
-    event: "firstUserInteraction";
-}
-export interface FinderReadyEvent extends FinderSharedEventProps {
-    source: "core";
-    event: "ready";
-}
-export type FinderEvent = FinderInitEvent | FinderFirstUserInteractionEvent | FinderReadyEvent | FinderChangeEvent;
-export type FinderOnInitCallback = (event: FinderInitEvent) => void;
-export type FinderOnReadyCallback = (event: FinderReadyEvent) => void;
-export type FinderOnFirstUserInteractCallback = (event: FinderFirstUserInteractionEvent) => void;
-export type FinderOnChangeCallback = (event: FinderChangeEvent) => void;
-export type FinderTouchCallback = (event: FinderTouchEvent) => void;
-/**
- * Internal communication between mixins and core
- */
-export interface FinderTouchEvent {
-    source: FinderTouchSource;
-    event: FinderEventName;
-    current: any;
-    initial: any;
-}
-/**
- * External type that consumers will receive
- */
-export type FinderChangeEvent = FinderTouchEvent & FinderSharedEventProps;
-export type FinderEventName = "init" | "firstUserInteraction" | "ready" | "change" | "change.core" | "change.core.setIsLoading" | "change.core.setIsDisabled" | "change.core.setItems" | "change.layout" | "change.layout.set" | "change.layout.reset" | `change.filters` | "change.filters.set" | `change.groupBy` | "change.groupBy.set" | "change.groupBy.setGroupIdSortDirection" | "change.meta" | "change.meta.set" | "change.meta.delete" | "change.meta.reset" | "change.pagination" | "change.pagination.setPage" | "change.pagination.setNumItemsPerPage" | `change.plugin` | `change.plugin.${string}` | "change.search" | "change.search.setSearchTerm" | "change.search.reset" | "change.selectedItems" | "change.selectedItems.setMaxSelectedItems" | "change.selectedItems.set" | "change.selectedItems.select" | "change.selectedItems.toggle" | "change.selectedItems.delete" | "change.selectedItems.reset" | "change.sortBy" | "change.sortBy.set" | "change.sortBy.setSortDirection";
-export type FinderPluginFn<T extends FinderPluginInterface> = (...args: any[]) => T;
-export interface FinderPluginInterface<FItem = any> {
-    id: string;
-    register: (finder: FinderCore<FItem>, touch: FinderTouchCallback) => void;
-    [k: string]: any;
-}
-export interface LayoutVariant {
-    id: string;
-}
-export {};