@hitgrab/finder 0.0.26-alpha → 0.1.3-alpha

package/dist/core/sort-by/sort-by.d.ts

@@ -1,18 +0,0 @@
-import { SortByRule, SortDirection } from "../../types";
-import { MixinInjectedDependencies } from "../types/internal-types";
-type InitialValues = {
-    initialSortBy: string | undefined;
-    initialSortDirection?: SortDirection;
-};
-declare class SortByMixin<FItem> {
-    #private;
-    constructor({ initialSortBy, initialSortDirection }: InitialValues, deps: MixinInjectedDependencies<FItem>);
-    get rules(): SortByRule<unknown>[];
-    get activeRule(): SortByRule<unknown> | undefined;
-    get sortDirection(): SortDirection;
-    get userHasSetSortDirection(): boolean;
-    setSortDirection(incomingSortDirection?: SortDirection): void;
-    set(identifier?: string | SortByRule, incomingSortDirection?: SortDirection): void;
-    process(items: FItem[]): FItem[];
-}
-export { SortByMixin };

package/dist/core/types/internal-types.d.ts

@@ -1,15 +0,0 @@
-/**
- * These internal types are not intended for public consumption.
- */
-import { FinderRule, FinderTouchCallback, MetaInterface } from "../../types";
-import { DebounceCallbackRegistry } from "../debounce-callback-registry/debounce-callback-registry";
-export interface MixinInjectedDependencies<FItem = any> {
-    isLoading: () => boolean;
-    isDisabled: () => boolean;
-    getRules: () => FinderRule[];
-    touch: FinderTouchCallback;
-    getMeta: () => MetaInterface;
-    getItems: () => FItem[];
-    debouncer: DebounceCallbackRegistry;
-}
-export type EventCallback = (payload?: any) => void;

package/dist/core/utils/finder-utils.d.ts

@@ -1,3 +0,0 @@
-export declare function clamp(value: number, min: number, max: number): number;
-export declare function simpleUniqBy<T>(data: T[], key: string): T[];
-export declare function range(start: number, end: number): number[];

package/dist/core/utils/string-compare-utils.d.ts

@@ -1,13 +0,0 @@
-/**
- * Case-insensitive sequential string comparison with line breaks and white spaces removed.
- * If the method receive an optional aliases array, each of those aliases will be compared as well.
- */
-export declare function finderStringCompare(haystack: string, needle: string, aliases?: string[] | null): boolean;
-/**
- * Compare if the same characters are all represented in a string.
- */
-export declare function finderCharacterCompare(haystack: string, needle: string, aliases?: string[] | null): boolean;
-/**
- * Compare if the same characters are represented sequentially in a string.
- */
-export declare function finderSequentialCharacterCompare(haystack: string, needle: string, aliases?: string[] | null): boolean;

package/dist/react/components/finder-empty.d.ts

@@ -1,6 +0,0 @@
-import { FinderBaseRenderProp } from "../types/react-types";
-interface FinderEmptyProps {
-    children: FinderBaseRenderProp;
-}
-declare function FinderEmpty({ children: renderProp }: FinderEmptyProps): Iterable<import("react").ReactNode> | import("react/jsx-runtime").JSX.Element | null;
-export { FinderEmpty };

package/dist/react/components/finder-groups.d.ts

@@ -1,7 +0,0 @@
-import { ElementType } from "react";
-import { FinderGroupsComponentProps } from "../types/react-types";
-interface FinderGroupsProps<FItem = any> {
-    children: ElementType<FinderGroupsComponentProps<FItem>>;
-}
-declare function FinderGroups<FItem>({ children: renderProp }: FinderGroupsProps<FItem>): import("react/jsx-runtime").JSX.Element | null;
-export { FinderGroups };

package/dist/react/components/finder-items.d.ts

@@ -1,7 +0,0 @@
-import { ElementType } from "react";
-import { FinderItemsComponentProps } from "../types/react-types";
-interface FinderItemsProps<FItem = any> {
-    children: ElementType<FinderItemsComponentProps<FItem>>;
-}
-declare function FinderItems<FItem>({ children: renderProp }: FinderItemsProps<FItem>): import("react/jsx-runtime").JSX.Element | null;
-export { FinderItems };

package/dist/react/components/finder-loading.d.ts

@@ -1,6 +0,0 @@
-import { FinderBaseRenderProp } from "../types/react-types";
-interface FinderLoadingProps {
-    children: FinderBaseRenderProp;
-}
-declare function FinderLoading({ children: renderProp }: FinderLoadingProps): Iterable<import("react").ReactNode> | import("react/jsx-runtime").JSX.Element | null;
-export { FinderLoading };

package/dist/react/components/finder-no-matches.d.ts

@@ -1,6 +0,0 @@
-import { FinderBaseRenderProp } from "../types/react-types";
-interface FinderNoMatchesProps {
-    children: FinderBaseRenderProp;
-}
-declare function FinderNoMatches({ children: renderProp }: FinderNoMatchesProps): Iterable<import("react").ReactNode> | import("react/jsx-runtime").JSX.Element | null;
-export { FinderNoMatches };

package/dist/react/components/finder-search-term.d.ts

@@ -1,7 +0,0 @@
-import { ElementType } from "react";
-interface FinderSearchTermProps {
-    children: string;
-    Component?: ElementType;
-}
-declare function FinderSearchTerm({ Component, children }: FinderSearchTermProps): string | import("react/jsx-runtime").JSX.Element;
-export { FinderSearchTerm };

package/dist/react/hooks/use-finder-context.d.ts

@@ -1,2 +0,0 @@
-declare function useFinderContext(): import("../../core/finder-core").FinderCore<any>;
-export { useFinderContext };

package/dist/react/providers/finder-context.d.ts

@@ -1,3 +0,0 @@
-import { FinderCore } from "../../core/finder-core";
-declare const FinderContext: import("react").Context<[FinderCore<any>, number | undefined] | null>;
-export { FinderContext };

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 {};