@hitgrab/finder 0.1.0-alpha → 0.1.4-alpha

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

@@ -0,0 +1,8 @@
+import { FinderSearchTermProp } from "../types/react-types";
+interface FinderSearchTermHaystackProps {
+    children: string;
+    Match?: FinderSearchTermProp;
+    Miss?: FinderSearchTermProp;
+}
+declare function FinderSearchTermHaystack({ Match, Miss, children: haystack }: FinderSearchTermHaystackProps): string | import("react/jsx-runtime").JSX.Element;
+export { FinderSearchTermHaystack };

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

@@ -1,9 +1,9 @@
 import { FinderProps } from "../types/react-types";
 import { FinderContent } from "./finder-content";
-import { FinderSearchTerm } from "./finder-search-term";
+import { FinderSearchTermHaystack } from "./finder-search-term-haystack";
 declare function Finder<FItem = any, FContext = any>({ items, rules, effects, initialSearchTerm, initialSortBy, initialSortDirection, initialGroupBy, initialFilters, context, isLoading, disabled, page, numItemsPerPage, requireGroup, ignoreSortByRulesWhileSearchRuleIsActive, onInit, onReady, onFirstUserInteraction, onChange, controllerRef, children, }: FinderProps<FItem, FContext>): import("react/jsx-runtime").JSX.Element;
 declare namespace Finder {
     var Content: typeof FinderContent;
-    var SearchTerm: typeof FinderSearchTerm;
+    var SearchTermHaystack: typeof FinderSearchTermHaystack;
 }
 export { Finder };

package/dist/react/components/string-match.d.ts

@@ -0,0 +1,12 @@
+import { FinderSearchTermProp } from "../types/react-types";
+interface StringMatchProps {
+    needle: string;
+    haystack: string;
+    Match?: FinderSearchTermProp;
+    Miss?: FinderSearchTermProp;
+}
+/**
+ * Split a string into result segment components .
+ */
+declare function StringMatch({ needle, haystack, Match, Miss }: StringMatchProps): string | (string | import("react/jsx-runtime").JSX.Element)[];
+export { StringMatch };

package/dist/react/types/react-types.d.ts

@@ -2,16 +2,15 @@
  * React-specific types for creating consumer components.
  */
 import { ElementType, PropsWithChildren, ReactElement, ReactNode, RefObject } from "react";
-import { paginationInterface } from "../../core/pagination/pagination-interface";
+import { FinderConstructorOptions, FinderResultGroup, PaginationMixinInterface } from "../../core/types/core-types";
+import { StringMatchSegment } from "../../core/types/string-match-types";
 import { FinderCore } from "../../core/finder-core";
-import { GroupByRule } from "../../core/types/rule-types";
-import { FinderConstructorOptions, FinderResultGroup } from "../../core/types/core-types";
 export interface FinderProps<FItem, FContext> extends FinderConstructorOptions<FItem, FContext>, PropsWithChildren {
     items: FItem[] | undefined | null;
     controllerRef?: RefObject<FinderCore<FItem, FContext> | null>;
 }
 export interface FinderContentProps<FContext = any> {
-    pagination: ReturnType<typeof paginationInterface>;
+    pagination: PaginationMixinInterface;
     context?: FContext;
 }
 export interface FinderContentItemProps<FItem, FContext = any> extends FinderContentProps<FContext> {
@@ -19,6 +18,10 @@ export interface FinderContentItemProps<FItem, FContext = any> extends FinderCon
 }
 export interface FinderContentGroupProps<FItem, FContext = any> extends FinderContentProps<FContext> {
     groups: FinderResultGroup<FItem>[];
-    rule: GroupByRule;
 }
 export type FinderContentRenderProp = ElementType<FinderContentProps> | ReactElement<FinderContentProps> | Iterable<ReactNode>;
+export interface StringMatchSegmentProps {
+    segment: StringMatchSegment;
+    segmentIndex: number;
+}
+export type FinderSearchTermProp = keyof HTMLElementTagNameMap | ElementType | ElementType<StringMatchSegmentProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hitgrab/finder",
-    "version": "0.1.0-alpha",
+    "version": "0.1.4-alpha",
     "description": "Headless datatables for things that aren't tables.",
     "type": "module",
     "files": [
@@ -25,9 +25,9 @@
     "scripts": {
         "dev": "vite",
         "build": "vite build && tsc --project tsconfig.production.json",
-        "build:docs": "npm --prefix docusaurus run build && rm -r docs && cp -r ./docusaurus/docs ./docs && mkdir ./docs/examples",
-        "build:armory": "npm --prefix examples/react-armory run build && cp -r ./examples/react-armory/dist ./docs/examples/armory",
-        "build:shoes": "npm --prefix examples/react-shoes run build && cp -r ./examples/react-shoes/dist ./docs/examples/shoes",
+        "build:docs": "npm --prefix docusaurus run build && rm -r docs && cp -r ./docusaurus/build ./docs && mkdir ./docs/examples",
+        "build:armory": "npm --prefix examples/react-armory run build && rm -r ./docs/examples/armory && cp -r ./examples/react-armory/dist ./docs/examples/armory",
+        "build:shoes": "npm --prefix examples/react-shoes run build && rm -r ./docs/examples/shoes && cp -r ./examples/react-shoes/dist ./docs/examples/shoes",
         "test": "vitest"
     },
     "repository": {
@@ -58,13 +58,14 @@
         "@types/react": "^19.1.3",
         "@types/react-dom": "^19.1.3",
         "@vitejs/plugin-react": "^4.3.2",
-        "eslint": "^8.57.1",
-        "eslint-config-airbnb": "^19.0.4",
-        "eslint-config-airbnb-base": "^15.0.0",
-        "eslint-config-airbnb-typescript": "^17.0.0",
-        "eslint-plugin-import": "^2.27.5",
+        "@eslint/js": "^9.36.0",
+        "eslint": "^9.36.0",
+        "eslint-plugin-jsx-a11y": "^6.10.2",
+        "eslint-plugin-react": "^7.37.5",
+        "eslint-plugin-react-hooks": "^5.2.0",
+        "typescript-eslint": "^8.45.0",
         "prettier": "^3.5.3",
-        "typescript": "^5.8.2",
+        "typescript": "^5.9.2",
         "vite": "^6.3.5",
         "vite-plugin-checker": "^0.9.0",
         "vitest": "^3.1.3"

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

@@ -1,8 +0,0 @@
-import { HydratedRuleEffect, HydratedSearchEffect, RuleEffect, SearchEffect } from "../types/effect-types";
-export declare class EffectBook<FItem, FContext> {
-    #private;
-    searchEffects: HydratedSearchEffect[];
-    ruleEffects: HydratedRuleEffect[];
-    constructor(effects: (RuleEffect | SearchEffect)[], items: FItem[], context: FContext);
-    hydrateDefinitions<FItem, FContext>(items: FItem[], context: FContext): void;
-}

package/dist/core/filters/filters-interface.d.ts

@@ -1,31 +0,0 @@
-import { FiltersMixin } from "./filters";
-/**
- * Public surface for the Filters mixin
- */
-declare function readonlyFiltersInterface(mixin: FiltersMixin): {
-    values: Record<string, any>;
-    raw: Record<string, any>;
-    activeRules: import("../..").HydratedFilterRule<unknown, any, any>[];
-    rules: import("../..").HydratedFilterRule<unknown, any, any>[];
-    isActive: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule) => boolean;
-    get: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule) => any;
-    has: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule, optionValue?: import("../..").FilterOption | any) => any;
-    getRule: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule) => import("../..").HydratedFilterRule<any, any, any> | undefined;
-};
-declare function filtersInterface(mixin: FiltersMixin): {
-    toggle: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule, optionValue?: import("../..").FilterOption | any) => void;
-    set: <FItem, FValue>(identifier: string | import("../..").FilterRuleUnion<FItem, FValue> | import("../..").HydratedFilterRule<FItem, FValue, any>, incomingFilterValue: FValue | FValue[]) => void;
-    delete: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule) => void;
-    test: (options: import("../types/rule-types").FilterTestOptions) => any[];
-    testRule: ({ rule: identifier, value, ...options }: import("../types/rule-types").FilterTestRuleOptions) => any[];
-    testRuleOptions: ({ rule: identifier, ...options }: import("../types/rule-types").FilterTestRuleOptionsOptions) => Map<any, any>;
-    values: Record<string, any>;
-    raw: Record<string, any>;
-    activeRules: import("../..").HydratedFilterRule<unknown, any, any>[];
-    rules: import("../..").HydratedFilterRule<unknown, any, any>[];
-    isActive: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule) => boolean;
-    get: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule) => any;
-    has: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule, optionValue?: import("../..").FilterOption | any) => any;
-    getRule: (identifier: string | import("../..").FilterRuleUnion | import("../..").HydratedFilterRule) => import("../..").HydratedFilterRule<any, any, any> | undefined;
-};
-export { readonlyFiltersInterface, filtersInterface };

package/dist/core/filters/filters.d.ts

@@ -1,28 +0,0 @@
-import { FilterOption, FilterRule, FilterRuleUnion, FilterTestOptions, FilterTestRuleOptions, FilterTestRuleOptionsOptions, HydratedFilterRule } from "../types/rule-types";
-import { MixinInjectedDependencies, SerializedFiltersMixin } from "../types/core-types";
-interface InitialValues {
-    initialFilters: Record<string, any> | undefined;
-}
-declare class FiltersMixin {
-    #private;
-    constructor({ initialFilters }: InitialValues, deps: MixinInjectedDependencies);
-    set<FItem, FValue>(identifier: FilterRuleUnion<FItem, FValue> | HydratedFilterRule<FItem, FValue> | string, incomingFilterValue: FValue | FValue[]): void;
-    get rules(): HydratedFilterRule<unknown, any, any>[];
-    get activeRules(): HydratedFilterRule<unknown, any, any>[];
-    get(identifier: string | FilterRuleUnion | HydratedFilterRule): any;
-    has(identifier: string | FilterRuleUnion | HydratedFilterRule, optionValue?: FilterOption | any): any;
-    getRule(identifier: string | FilterRuleUnion | HydratedFilterRule): HydratedFilterRule<any, any, any> | undefined;
-    delete(identifier: string | FilterRuleUnion | HydratedFilterRule): void;
-    isRuleActive(identifier: string | FilterRuleUnion | HydratedFilterRule): boolean;
-    toggle(identifier: string | FilterRuleUnion | HydratedFilterRule, optionValue?: FilterOption | any): void;
-    test(options: FilterTestOptions): any[];
-    testRule({ rule: identifier, value, ...options }: FilterTestRuleOptions): any[];
-    testRuleOptions({ rule: identifier, ...options }: FilterTestRuleOptionsOptions): Map<any, any>;
-    getValues(): Record<string, any>;
-    getRawValues(): Record<string, any>;
-    serialize(): SerializedFiltersMixin;
-    static process<FItem>(options: SerializedFiltersMixin, items: FItem[], context?: any): FItem[];
-    static isRuleActive(rule: FilterRuleUnion | HydratedFilterRule, value: any): boolean;
-    static hydrateRule<FItem = any, FContext = any>(rule: FilterRule, items: FItem[], context: FContext): HydratedFilterRule;
-}
-export { FiltersMixin };

package/dist/core/group-by/group-by-interface.d.ts

@@ -1,21 +0,0 @@
-import { GroupByMixin } from "./group-by";
-/**
- * Public surface for the Group By mixin
- */
-declare function readonlyGroupByInterface<FItem, FContext>(mixin: GroupByMixin<FItem, FContext>): {
-    activeRule: import("../..").GroupByRule<unknown, any> | undefined;
-    requireGroup: boolean;
-    rules: import("../..").GroupByRule<unknown, any>[];
-    groupIdSortDirection: import("../..").SortDirection | undefined;
-};
-declare function groupByInterface<FItem, FContext>(mixin: GroupByMixin<FItem, FContext>): {
-    set: (identifier?: string | import("../..").GroupByRule) => void;
-    toggle: (identifier: import("../..").GroupByRule | string) => void;
-    setGroupIdSortDirection: (direction?: import("../..").SortDirection) => void;
-    reset: () => void;
-    activeRule: import("../..").GroupByRule<unknown, any> | undefined;
-    requireGroup: boolean;
-    rules: import("../..").GroupByRule<unknown, any>[];
-    groupIdSortDirection: import("../..").SortDirection | undefined;
-};
-export { readonlyGroupByInterface, groupByInterface };

package/dist/core/pagination/pagination-interface.d.ts

@@ -1,23 +0,0 @@
-import { PaginationMixin } from "./pagination";
-/**
- * Public surface for the pagination mixin
- */
-declare function readonlyPaginationInterface<FItem>(mixin: PaginationMixin<FItem>): {
-    page: number;
-    offset: number;
-    numItemsPerPage: number | undefined;
-    numTotalItems: number;
-    lastPage: number | undefined;
-    isPaginated: boolean;
-};
-declare function paginationInterface<FItem>(mixin: PaginationMixin<FItem>): {
-    setPage: (value: number) => void;
-    setNumItemsPerPage: (value?: number) => void;
-    page: number;
-    offset: number;
-    numItemsPerPage: number | undefined;
-    numTotalItems: number;
-    lastPage: number | undefined;
-    isPaginated: boolean;
-};
-export { readonlyPaginationInterface, paginationInterface };

package/dist/core/search/algorithms/sequential-characters.d.ts

@@ -1 +0,0 @@
-export declare function calculateSequentialCharacterIndexes(haystack: string, needle: string): number[] | undefined;

package/dist/core/search/algorithms/sequential-string.d.ts

@@ -1 +0,0 @@
-export declare function calculateSequentialStringCharacterIndexes(haystack: string, needle: string): number[] | undefined;

package/dist/core/search/result-segments/result-segment-types.d.ts

@@ -1,17 +0,0 @@
-/**
- * Internal type used to prepare the result segment. These values all point to the transformed haystack.
- */
-export interface ResultSegmentInternal {
-    start: number;
-    end: number;
-    length: number;
-    is_match: boolean;
-    value: string;
-    _internal: true;
-}
-/**
- * Consumable type ready for use. All values are mapped to the haystack source.
- */
-export interface ResultSegment extends Omit<ResultSegmentInternal, "_internal"> {
-}
-export type SearchCharacterIndexFn = (haystack: string, needle: string) => number[] | undefined;

package/dist/core/search/search-interface.d.ts

@@ -1,15 +0,0 @@
-import { SearchMixin } from "./search";
-declare function readonlySearchInterface<FItem>(mixin: SearchMixin<FItem>): {
-    searchTerm: string;
-    hasSearchTerm: boolean;
-    hasSearchRule: boolean;
-};
-declare function searchInterface<FItem>(mixin: SearchMixin<FItem>): {
-    setSearchTerm: (incomingSearchTerm: string) => void;
-    reset: () => void;
-    test: (searchTerm: string, isAdditive?: boolean) => FItem[];
-    searchTerm: string;
-    hasSearchTerm: boolean;
-    hasSearchRule: boolean;
-};
-export { readonlySearchInterface, searchInterface };

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

@@ -1,23 +0,0 @@
-import { SortDirection } from "../types/core-types";
-import { SortByMixin } from "./sort-by";
-/**
- * Public surface for the SortBy mixin
- */
-declare function readonlySortByInterface<FItem>(mixin: SortByMixin<FItem>): {
-    activeRule: import("../..").SortByRule<unknown, any> | undefined;
-    sortDirection: SortDirection;
-    userHasSetSortDirection: boolean;
-    rules: import("../..").SortByRule<unknown, any>[];
-};
-declare function sortByInterface<FItem>(mixin: SortByMixin<FItem>): {
-    set: (identifier?: string | import("../..").SortByRule, incomingSortDirection?: SortDirection) => void;
-    setSortDirection: (incomingSortDirection?: SortDirection) => void;
-    cycleSortDirection: () => void;
-    toggleSortDirection: () => void;
-    reset(): void;
-    activeRule: import("../..").SortByRule<unknown, any> | undefined;
-    sortDirection: SortDirection;
-    userHasSetSortDirection: boolean;
-    rules: import("../..").SortByRule<unknown, any>[];
-};
-export { readonlySortByInterface, sortByInterface };

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/react/components/finder-search-term.d.ts

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

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

@@ -1,7 +0,0 @@
-import { FinderCore } from "../../core/finder-core";
-import { FinderConstructorOptions } from "../../core/types/core-types";
-/**
- * Create a finder instance with contained state and controllers.
- */
-declare function useFinderConstructor<FItem>(items: FItem[] | null | undefined, { rules, initialSearchTerm, initialSortBy, initialSortDirection, initialGroupBy, initialFilters, context, page, numItemsPerPage, isLoading, disabled, requireGroup, onInit, onReady, onFirstUserInteraction, onChange, }: FinderConstructorOptions<FItem>): FinderCore<FItem>;
-export { useFinderConstructor };