@hitgrab/finder 0.1.18-alpha → 0.1.19-alpha

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

@@ -1,20 +0,0 @@
-import { FinderCore } from "../finder-core";
-import { RuleDefinition } from "./rule-types";
-export interface RuleEffect<FItem = any, FContext = any> {
-    rules: string | RuleDefinition<FItem> | (string | RuleDefinition<FItem>)[] | ((items: FItem[], context: FContext) => string | RuleDefinition<FItem> | (string | RuleDefinition<FItem>)[]);
-    onChange: (instance: FinderCore<FItem, FContext>, rule: RuleDefinition<FItem>) => void;
-}
-export interface HydratedRuleEffect<FItem = any, FContext = any> {
-    rules: (string | RuleDefinition<FItem>)[];
-    onChange: (instance: FinderCore<FItem, FContext>, rule: RuleDefinition<FItem>) => void;
-    _isHydrated: true;
-}
-export interface SearchEffect<FItem = any, FContext = any> {
-    haystack: string | string[] | ((items: FItem[], context: FContext) => string | string[]);
-    onChange: (instance: FinderCore<FItem, FContext>, searchTerm: string) => void;
-}
-export interface HydratedSearchEffect<FItem = any, FContext = any> {
-    haystack: string[];
-    onChange: (instance: FinderCore<FItem, FContext>, searchTerm: string) => void;
-    _isHydrated: true;
-}

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

@@ -1,44 +0,0 @@
-import { EVENT_SOURCE, EVENTS } from "../core-constants";
-import { FinderCore } from "../finder-core";
-import { RuleDefinition } from "./rule-types";
-export type FinderTouchSource = (typeof EVENT_SOURCE)[keyof typeof EVENT_SOURCE];
-interface FinderSharedEventProps {
-    source: string;
-    event: FinderEventName;
-    timestamp: number;
-    instance: FinderCore;
-}
-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;
-    rule?: RuleDefinition;
-}
-/**
- * External type that consumers will receive
- */
-export type FinderChangeEvent = FinderTouchEvent & FinderSharedEventProps;
-export type FinderEventName = (typeof EVENTS)[keyof typeof EVENTS];
-export {};

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

@@ -1,89 +0,0 @@
-import { FinderResultGroup, SortDirection } from "./core-types";
-/**
- * Select a property from the item to sort by.
- */
-export type FinderPropertySelector<FItem, FContext = any> = (item: FItem, context: FContext) => string | number;
-interface Rule {
-    id: string;
-    debounceMilliseconds?: number;
-    label?: string;
-    hidden?: boolean;
-}
-export type RuleDefinition<FItem = any, FContext = any> = SearchRuleDefinition<FItem, FContext> | FilterRuleDefinition<FItem, FContext> | SortByRuleDefinition<FItem, FContext> | GroupByRuleDefinition<FItem, FContext>;
-export interface SearchRuleDefinition<FItem = any, FContext = any> extends Omit<Rule, "id"> {
-    id?: string;
-    searchFn?: (item: FItem, context: FContext) => string | string[];
-}
-/**
- * Describes the display of a filter or sort option.
- */
-export interface FilterOption<FValue = any> {
-    label?: string;
-    value: FValue;
-    disabled?: boolean;
-}
-export interface FilterRuleDefinition<FItem = any, FValue = any, FContext = any> extends Rule {
-    filterFn: (item: FItem, value: FValue, context: FContext) => boolean;
-    required?: boolean;
-    strictOptions?: boolean;
-    multiple?: boolean;
-    boolean?: boolean;
-    options?: FilterOption<FValue>[] | ((options: {
-        items: FItem[];
-        context: FContext;
-    }) => FilterOption<FValue>[]);
-}
-export type AnyFilterRuleDefinition<FItem = any, FValue = any> = Omit<FilterRuleDefinition<FItem, FValue>, "options">;
-export interface FilterRuleWithBooleanValue<FItem = any, FValue = boolean, FContext = any> extends FilterRuleDefinition<FItem, FValue, FContext> {
-    multiple?: false;
-    boolean: true;
-    defaultValue?: boolean;
-    options?: never;
-}
-export interface FilterRuleWithSingleValue<FItem = any, FValue = any, FContext = any> extends FilterRuleDefinition<FItem, FValue, FContext> {
-    multiple?: false;
-    boolean?: false;
-    defaultValue?: FValue;
-}
-export interface FilterRuleWithMultipleValues<FItem = any, FValue = any, FContext = any> extends FilterRuleDefinition<FItem, FValue, FContext> {
-    multiple: true;
-    boolean?: false;
-    defaultValue?: FValue[];
-}
-/**
- * A hydrated filter has rendered any option generator functions, and narrowed ambiguous properties from FilterRule.
- */
-export interface HydratedFilterRuleDefinition<FItem = any, FValue = any, FContext = any> extends FilterRuleDefinition<FItem, FValue, FContext> {
-    options?: FilterOption<FValue>[];
-    multiple: boolean;
-    boolean: boolean;
-    _isHydrated: true;
-}
-export interface SortByRuleDefinition<FItem = any, FContext = any> extends Rule {
-    sortFn: FinderPropertySelector<FItem, FContext> | FinderPropertySelector<FItem, FContext>[];
-    defaultSortDirection?: SortDirection;
-}
-export interface GroupByRuleDefinition<FItem = any, FContext = any> extends Rule {
-    groupFn: FinderPropertySelector<FItem, FContext>;
-    sortGroupFn?: FinderPropertySelector<FinderResultGroup<FItem>, FContext>;
-    defaultGroupSortDirection?: SortDirection;
-    sticky?: {
-        header?: string | string[];
-        footer?: string | string[];
-    };
-}
-export interface SearchTestOptions {
-    rule: SearchRuleDefinition[];
-    searchTerm: string;
-}
-export interface FilterTestOptions {
-    rules: HydratedFilterRuleDefinition[];
-    values?: Record<string, any>;
-    isAdditive?: boolean;
-}
-export interface FilterTestRuleOptions {
-    rule: string | AnyFilterRuleDefinition;
-    value: any;
-    isAdditive?: boolean;
-}
-export {};

package/dist/core/types/string-match-types.d.ts

@@ -1,10 +0,0 @@
-/**
- *  These values all point to the transformed haystack.
- */
-export interface StringMatchSegment {
-    index: number;
-    length: number;
-    is_match: boolean;
-    value: string;
-}
-export type SearchCharacterIndexFn = (haystack: string, needle: string) => number[] | undefined;

package/dist/core/utils/rule-type-enforcers.d.ts

@@ -1,18 +0,0 @@
-import { FinderCore } from "../finder-core";
-import { RuleEffect, SearchEffect } from "../types/effect-types";
-import { FilterRuleWithBooleanValue, FilterRuleWithMultipleValues, FilterRuleWithSingleValue, RuleDefinition, GroupByRuleDefinition, SearchRuleDefinition, SortByRuleDefinition, AnyFilterRuleDefinition } from "../types/rule-types";
-/**
- * Enforce structure for an array of rule of mixed types.
- */
-export declare function finderRuleset<FItem, FContext = any>(rules: RuleDefinition<FItem, FContext>[]): RuleDefinition<FItem, FContext>[];
-export declare function searchRule<FItem, FContext = any>(rule: SearchRuleDefinition<FItem, FContext>): SearchRuleDefinition<FItem, FContext>;
-export declare function filterRule<FItem, FValue = any, FContext = any, T = FilterRuleWithMultipleValues<FItem, FValue, FContext>>(rule: T): FilterRuleWithMultipleValues<FItem, FValue>;
-export declare function filterRule<FItem, FValue = boolean, FContext = any, T = FilterRuleWithBooleanValue<FItem, FValue, FContext>>(rule: T): FilterRuleWithBooleanValue<FItem, FValue>;
-export declare function filterRule<FItem, FValue = any, FContext = any, T = FilterRuleWithSingleValue<FItem, FValue, FContext>>(rule: T): FilterRuleWithSingleValue<FItem, FValue>;
-export declare function sortByRule<FItem, FContext = any>(rule: SortByRuleDefinition<FItem, FContext>): SortByRuleDefinition<FItem, FContext>;
-export declare function groupByRule<FItem, FContext = any>(rule: GroupByRuleDefinition<FItem, FContext>): GroupByRuleDefinition<FItem, FContext>;
-export declare function ruleEffect<FItem, FContext = any>(rules: string | RuleDefinition<FItem> | (string | RuleDefinition<FItem>)[] | ((items: FItem[], context: FContext) => string | RuleDefinition<FItem> | (string | RuleDefinition<FItem>)[]), onChange: (instance: FinderCore<FItem, FContext>, rule: RuleDefinition) => void): RuleEffect<FItem, FContext>;
-export declare function searchEffect<FItem, FContext = any>(haystack: string | string[] | ((items: FItem[], context: FContext) => string | string[]), onChange: (instance: FinderCore<FItem, FContext>, searchTerm: string) => void): SearchEffect<FItem, FContext>;
-export declare function transformFilterToSingleValue<FItem, FValue, FContext = any>(filter: AnyFilterRuleDefinition<FItem, FValue>): FilterRuleWithMultipleValues<FItem, FValue, FContext>;
-export declare function transformFilterToBoolean<FItem, FValue, FContext = any>(filter: AnyFilterRuleDefinition<FItem, FValue>): FilterRuleWithBooleanValue<FItem, boolean, FContext>;
-export declare function transformFilterToMultiple<FItem, FValue, FContext = any>(filter: AnyFilterRuleDefinition<FItem, FValue>): FilterRuleWithMultipleValues<FItem, FValue, FContext>;

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

@@ -1,14 +0,0 @@
-import { RuleEffect, SearchEffect } from "../types/effect-types";
-import { FilterRuleWithBooleanValue, FilterRuleWithMultipleValues, FilterRuleWithSingleValue, GroupByRuleDefinition, HydratedFilterRuleDefinition, SearchRuleDefinition, SortByRuleDefinition } from "../types/rule-types";
-type FilterRuleUnion<FItem> = FilterRuleWithSingleValue<FItem> | FilterRuleWithMultipleValues<FItem> | FilterRuleWithBooleanValue<FItem>;
-export declare function isSortByRuleDefinition<FItem>(rule: unknown): rule is SortByRuleDefinition<FItem>;
-export declare function isSearchRuleDefinition<FItem>(rule: unknown): rule is SearchRuleDefinition<FItem>;
-export declare function isFilterRuleDefinition<FItem>(rule: unknown): rule is FilterRuleUnion<FItem>;
-export declare function isFilterRuleDefinitionWithHydratedOptions(rule: unknown): rule is HydratedFilterRuleDefinition;
-export declare function isGroupByRuleDefinition<FItem>(rule: unknown): rule is GroupByRuleDefinition<FItem>;
-export declare function isRuleEffectDefinition<FItem>(data: unknown): data is RuleEffect<FItem>;
-export declare function isSearchEffectDefinition<FItem>(data: unknown): data is SearchEffect<FItem>;
-export declare function isBooleanFilterRuleDefinition<FItem>(rule: unknown): rule is FilterRuleWithBooleanValue<FItem>;
-export declare function isMultipleValueFilterRuleDefinition<FItem>(rule: unknown): rule is FilterRuleWithMultipleValues<FItem>;
-export declare function isSingleValueFilterRuleDefinition<FItem>(rule: unknown): rule is FilterRuleWithSingleValue<FItem>;
-export {};

package/dist/index.d.ts

@@ -1,13 +0,0 @@
-export type { FinderConstructorOptions, FinderResultGroup, SortDirection } from "./core/types/core-types";
-export { finderRuleset, searchRule, filterRule, sortByRule, groupByRule, ruleEffect, searchEffect, transformFilterToSingleValue, transformFilterToMultiple, transformFilterToBoolean, } from "./core/utils/rule-type-enforcers";
-export type { SearchRuleDefinition, SortByRuleDefinition, GroupByRuleDefinition, FilterRuleDefinition, FilterOption, AnyFilterRuleDefinition, } from "./core/types/rule-types";
-export type { RuleEffect, SearchEffect } from "./core/types/effect-types";
-export type { FinderEvent, FinderInitEvent, FinderReadyEvent, FinderFirstUserInteractionEvent, FinderChangeEvent } from "./core/types/event-types";
-/**
- * React hooks and components
- */
-export { useFinder } from "./react/hooks/use-finder";
-export { Finder } from "./react/components/finder";
-export { useFinderRef } from "./react/hooks/use-finder-ref";
-export { StringMatch } from "./react/components/string-match";
-export type { FinderProps, FinderContentProps, StringMatchSegmentProps } from "./react/types/react-types";