@hitgrab/finder 0.1.17-alpha → 0.1.19-alpha

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 { FinderRule } 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?: FinderRule;
-}
-/**
- * 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,93 +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 RuleBase {
-    id: string;
-    debounceMilliseconds?: number;
-    label?: string;
-    hidden?: boolean;
-}
-export type FinderRule<FItem = any, FContext = any> = SearchRule<FItem, FContext> | FilterRuleUnion<FItem, FContext> | HydratedFilterRule<FItem, FContext> | SortByRule<FItem, FContext> | GroupByRule<FItem, FContext>;
-export type HydratedFinderRule<FItem = any, FContext = any> = SearchRule<FItem, FContext> | HydratedFilterRule<FItem, FContext> | SortByRule<FItem, FContext> | GroupByRule<FItem, FContext>;
-export interface SearchRule<FItem = any, FContext = any> extends Omit<RuleBase, "id"> {
-    id?: string;
-    searchFn?: (item: FItem, context: FContext) => string | string[];
-}
-export interface FilterOptionGeneratorFnOptions<FItem, FContext = any> {
-    items: FItem[];
-    context: FContext;
-}
-/**
- * Describes the display of a filter or sort option.
- */
-export interface FilterOption<FValue = any> {
-    label: string;
-    value: FValue;
-    disabled?: boolean;
-}
-export interface FilterRule<FItem = any, FValue = any, FContext = any> extends RuleBase {
-    options?: FilterOption<FValue>[] | ((options: FilterOptionGeneratorFnOptions<FItem, FContext>) => FilterOption<FValue>[]);
-    required?: boolean;
-}
-export interface FilterRuleWithBooleanValue<FItem, FContext = any> extends FilterRule<FItem> {
-    multiple?: false;
-    boolean: true;
-    filterFn: (item: FItem, value: boolean, context: FContext) => boolean;
-    defaultValue?: boolean;
-}
-export interface FilterRuleWithSingleValue<FItem, FValue, FContext = any> extends FilterRule<FItem, FValue, FContext> {
-    multiple?: false;
-    boolean?: false;
-    filterFn: (item: FItem, value: FValue, context: FContext) => boolean;
-    defaultValue?: FValue;
-}
-export interface FilterRuleWithMultipleValues<FItem, FValue, FContext = any> extends FilterRule<FItem, FValue, FContext> {
-    multiple: true;
-    boolean?: false;
-    filterFn: (item: FItem, value: FValue[], context: FContext) => boolean;
-    defaultValue?: FValue[];
-}
-export type FilterRuleUnion<FItem = any, FValue = any> = FilterRuleWithBooleanValue<FItem> | FilterRuleWithSingleValue<FItem, FValue> | FilterRuleWithMultipleValues<FItem, FValue>;
-/**
- * A hydrated filter has rendered any option generator functions, and narrowed ambiguous properties from FilterRule.
- */
-export interface HydratedFilterRule<FItem = any, FValue = any, FContext = any> extends Omit<FilterRule<FItem, FValue>, "options"> {
-    options?: FilterOption<FValue>[];
-    required: boolean;
-    boolean: boolean;
-    hidden: boolean;
-    multiple: boolean;
-    filterFn: ((item: FItem, value: FValue, context: FContext) => boolean) | ((item: FItem, value: FValue[], context: FContext) => boolean);
-    defaultValue?: boolean | FValue | FValue[];
-    _isHydrated: true;
-}
-export interface SortByRule<FItem = any, FContext = any> extends RuleBase {
-    sortFn: FinderPropertySelector<FItem, FContext> | FinderPropertySelector<FItem, FContext>[];
-    defaultSortDirection?: SortDirection;
-}
-export interface GroupByRule<FItem = any, FContext = any> extends RuleBase {
-    groupFn: FinderPropertySelector<FItem, FContext>;
-    sortGroupFn?: FinderPropertySelector<FinderResultGroup<FItem>, FContext>;
-    defaultGroupSortDirection?: SortDirection;
-    sticky?: {
-        header?: string | string[];
-        footer?: string | string[];
-    };
-}
-export interface SearchTestOptions {
-    rule: SearchRule[];
-    searchTerm: string;
-}
-export interface FilterTestOptions {
-    rules: HydratedFilterRule[];
-    values?: Record<string, any>;
-    isAdditive?: boolean;
-}
-export interface FilterTestRuleOptions {
-    rule: string | FilterRuleUnion | HydratedFilterRule;
-    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,15 +0,0 @@
-import { FinderCore } from "../finder-core";
-import { RuleEffect, SearchEffect } from "../types/effect-types";
-import { FilterRuleWithBooleanValue, FilterRuleWithMultipleValues, FilterRuleWithSingleValue, FinderRule, GroupByRule, SearchRule, SortByRule } from "../types/rule-types";
-/**
- * Enforce structure for an array of rule of mixed types.
- */
-export declare function finderRuleset<FItem, FContext = any>(rules: FinderRule<FItem, FContext>[]): FinderRule<FItem, FContext>[];
-export declare function searchRule<FItem, FContext = any>(rule: SearchRule<FItem, FContext>): SearchRule<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 = any, FContext = any, T = FilterRuleWithBooleanValue<FItem, 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: SortByRule<FItem, FContext>): SortByRule<FItem, FContext>;
-export declare function groupByRule<FItem, FContext = any>(rule: GroupByRule<FItem, FContext>): GroupByRule<FItem, FContext>;
-export declare function ruleEffect<FItem, FContext = any>(rules: string | FinderRule<FItem> | (string | FinderRule<FItem>)[] | ((items: FItem[], context: FContext) => string | FinderRule<FItem> | (string | FinderRule<FItem>)[]), onChange: (instance: FinderCore<FItem, FContext>, rule: FinderRule) => 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>;

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

@@ -1,9 +0,0 @@
-import { RuleEffect, SearchEffect } from "../types/effect-types";
-import { FilterRuleUnion, GroupByRule, HydratedFilterRule, SearchRule, SortByRule } from "../types/rule-types";
-export declare function isSortByRule<FItem>(rule: unknown): rule is SortByRule<FItem>;
-export declare function isSearchRule<FItem>(rule: unknown): rule is SearchRule<FItem>;
-export declare function isFilterRule<FItem>(rule: unknown): rule is FilterRuleUnion<FItem>;
-export declare function isHydratedFilterRule<FItem>(rule: unknown): rule is HydratedFilterRule<FItem>;
-export declare function isGroupByRule<FItem>(rule: unknown): rule is GroupByRule<FItem>;
-export declare function isRuleEffect<FItem>(data: unknown): data is RuleEffect<FItem>;
-export declare function isSearchEffect<FItem>(data: unknown): data is SearchEffect<FItem>;

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 } from "./core/utils/rule-type-enforcers";
-export type { FinderRule, SearchRule, SortByRule, GroupByRule, FilterRule, HydratedFilterRule, FilterRuleUnion, FilterOption } 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";