feat(core): pass refresh to all events

Author: francoischalifour

packages/autocomplete-core/src/__tests__/getInputProps.test.ts

@@ -459,6 +459,7 @@ describe('getInputProps', () => {
       });
       const {
         inputElement,
+        refresh,
         setCollections,
         setContext,
         setIsOpen,
@@ -481,6 +482,7 @@ describe('getInputProps', () => {
         item: { label: '1', __autocomplete_id: 0 },
         itemInputValue: 'a',
         itemUrl: undefined,
+        refresh,
         source: expect.any(Object),
         setCollections,
         setContext,
@@ -631,6 +633,7 @@ describe('getInputProps', () => {
         const onHighlight = jest.fn();
         const {
           inputElement,
+          refresh,
           setCollections,
           setContext,
           setIsOpen,
@@ -660,6 +663,7 @@ describe('getInputProps', () => {
           itemInputValue: 'a',
           itemUrl: undefined,
           source: expect.any(Object),
+          refresh,
           setCollections,
           setContext,
           setIsOpen,
@@ -869,6 +873,7 @@ describe('getInputProps', () => {
           };
           const {
             inputElement,
+            refresh,
             setCollections,
             setContext,
             setIsOpen,
@@ -904,6 +909,7 @@ describe('getInputProps', () => {
             },
             itemInputValue: '',
             itemUrl: '#1',
+            refresh,
             setCollections,
             setContext,
             setIsOpen,
@@ -1004,6 +1010,7 @@ describe('getInputProps', () => {
           };
           const {
             inputElement,
+            refresh,
             setCollections,
             setContext,
             setIsOpen,
@@ -1036,6 +1043,7 @@ describe('getInputProps', () => {
             item: { label: '1' },
             itemInputValue: '',
             itemUrl: undefined,
+            refresh,
             setCollections,
             setContext,
             setIsOpen,

packages/autocomplete-core/src/__tests__/onReset.test.ts

@@ -21,6 +21,7 @@ describe('onReset', () => {
     expect(onResetProp).toHaveBeenCalledTimes(1);
     expect(onResetProp).toHaveBeenCalledWith({
       event: expect.any(Event),
+      refresh: expect.any(Function),
       setCollections: expect.any(Function),
       setContext: expect.any(Function),
       setIsOpen: expect.any(Function),

packages/autocomplete-core/src/__tests__/onSubmit.test.ts

@@ -21,6 +21,7 @@ describe('onSubmit', () => {
     expect(onSubmitProp).toHaveBeenCalledTimes(1);
     expect(onSubmitProp).toHaveBeenCalledWith({
       event: expect.any(Event),
+      refresh: expect.any(Function),
       setCollections: expect.any(Function),
       setContext: expect.any(Function),
       setIsOpen: expect.any(Function),

packages/autocomplete-core/src/createAutocomplete.ts

@@ -9,7 +9,7 @@ import {
   AutocompleteApi,
   AutocompleteOptions,
   BaseItem,
-  Subscribers,
+  AutocompleteSubscribers,
 } from './types';
 
 export function createAutocomplete<
@@ -22,7 +22,7 @@ export function createAutocomplete<
 ): AutocompleteApi<TItem, TEvent, TMouseEvent, TKeyboardEvent> {
   checkOptions(options);
 
-  const subscribers: Subscribers<TItem> = [];
+  const subscribers: AutocompleteSubscribers<TItem> = [];
   const props = getDefaultProps(options, subscribers);
   const store = createStore(stateReducer, props);
 

packages/autocomplete-core/src/getDefaultProps.ts

@@ -2,7 +2,7 @@ import {
   AutocompleteOptions,
   BaseItem,
   InternalAutocompleteOptions,
-  Subscribers,
+  AutocompleteSubscribers,
 } from './types';
 import {
   generateAutocompleteId,
@@ -13,7 +13,7 @@ import {
 
 export function getDefaultProps<TItem extends BaseItem>(
   props: AutocompleteOptions<TItem>,
-  subscribers: Subscribers<TItem>
+  subscribers: AutocompleteSubscribers<TItem>
 ): InternalAutocompleteOptions<TItem> {
   const environment: InternalAutocompleteOptions<TItem>['environment'] = (typeof window !==
   'undefined'

packages/autocomplete-core/src/getPropGetters.ts

@@ -1,27 +1,25 @@
 import { onInput } from './onInput';
 import { onKeyDown } from './onKeyDown';
 import {
-  InternalAutocompleteOptions,
-  AutocompleteSetters,
+  AutocompleteScopeApi,
   AutocompleteStore,
-  AutocompleteRefresh,
-  GetPanelProps,
+  BaseItem,
   GetEnvironmentProps,
   GetFormProps,
   GetInputProps,
   GetItemProps,
   GetLabelProps,
   GetListProps,
+  GetPanelProps,
   GetRootProps,
-  BaseItem,
+  InternalAutocompleteOptions,
 } from './types';
 import { getSelectedItem, isOrContainsNode } from './utils';
 
 interface GetPropGettersOptions<TItem extends BaseItem>
-  extends AutocompleteSetters<TItem> {
+  extends AutocompleteScopeApi<TItem> {
   store: AutocompleteStore<TItem>;
   props: InternalAutocompleteOptions<TItem>;
-  refresh: AutocompleteRefresh;
 }
 
 export function getPropGetters<
@@ -121,6 +119,7 @@ export function getPropGetters<
           setIsOpen,
           setStatus,
           setContext,
+          refresh,
           event,
         });
 
@@ -141,6 +140,7 @@ export function getPropGetters<
           setIsOpen,
           setStatus,
           setContext,
+          refresh,
           event,
         });
 
@@ -324,6 +324,7 @@ export function getPropGetters<
             setIsOpen,
             setStatus,
             setContext,
+            refresh,
             event,
           });
         }
@@ -380,6 +381,7 @@ export function getPropGetters<
             setIsOpen,
             setStatus,
             setContext,
+            refresh,
             event,
           });
         });

packages/autocomplete-core/src/onInput.ts

@@ -1,8 +1,7 @@
 import {
-  AutocompleteSetters,
+  AutocompleteScopeApi,
   AutocompleteState,
   AutocompleteStore,
-  AutocompleteRefresh,
   BaseItem,
   InternalAutocompleteOptions,
 } from './types';
@@ -11,7 +10,7 @@ import { getSelectedItem } from './utils';
 let lastStalledId: number | null = null;
 
 interface OnInputParams<TItem extends BaseItem>
-  extends AutocompleteSetters<TItem> {
+  extends AutocompleteScopeApi<TItem> {
   query: string;
   event: any;
   store: AutocompleteStore<TItem>;
@@ -24,7 +23,6 @@ interface OnInputParams<TItem extends BaseItem>
    * but we want to close the panel in that case.
    */
   nextState?: Partial<AutocompleteState<TItem>>;
-  refresh: AutocompleteRefresh;
 }
 
 export function onInput<TItem extends BaseItem>({
@@ -151,6 +149,7 @@ export function onInput<TItem extends BaseItem>({
               setIsOpen,
               setStatus,
               setContext,
+              refresh,
               event,
             });
           }

packages/autocomplete-core/src/onKeyDown.ts

@@ -1,19 +1,17 @@
 import { onInput } from './onInput';
 import {
-  AutocompleteSetters,
+  AutocompleteScopeApi,
   AutocompleteStore,
-  AutocompleteRefresh,
   BaseItem,
   InternalAutocompleteOptions,
 } from './types';
 import { getSelectedItem } from './utils';
 
 interface OnKeyDownOptions<TItem extends BaseItem>
-  extends AutocompleteSetters<TItem> {
+  extends AutocompleteScopeApi<TItem> {
   event: KeyboardEvent;
   store: AutocompleteStore<TItem>;
   props: InternalAutocompleteOptions<TItem>;
-  refresh: AutocompleteRefresh;
 }
 
 export function onKeyDown<TItem extends BaseItem>({
@@ -66,6 +64,7 @@ export function onKeyDown<TItem extends BaseItem>({
         setIsOpen,
         setStatus,
         setContext,
+        refresh,
         event,
       });
     }
@@ -110,6 +109,7 @@ export function onKeyDown<TItem extends BaseItem>({
           setIsOpen,
           setStatus,
           setContext,
+          refresh,
           event,
         });
         props.navigator.navigateNewTab({
@@ -132,6 +132,7 @@ export function onKeyDown<TItem extends BaseItem>({
           setIsOpen,
           setStatus,
           setContext,
+          refresh,
           event,
         });
         props.navigator.navigateNewWindow({
@@ -156,6 +157,7 @@ export function onKeyDown<TItem extends BaseItem>({
           setIsOpen,
           setStatus,
           setContext,
+          refresh,
           event,
         });
         props.navigator.navigate({
@@ -195,6 +197,7 @@ export function onKeyDown<TItem extends BaseItem>({
           setIsOpen,
           setStatus,
           setContext,
+          refresh,
           event,
         });
       });

packages/autocomplete-core/src/types/AutocompleteApi.ts

@@ -0,0 +1,20 @@
+import { AutocompletePropGetters } from './AutocompletePropGetters';
+import { AutocompleteSetters } from './AutocompleteSetters';
+
+export type BaseItem = Record<string, unknown>;
+
+export interface AutocompleteScopeApi<TItem extends BaseItem>
+  extends AutocompleteSetters<TItem> {
+  /**
+   * Triggers a search to refresh the state.
+   */
+  refresh: () => Promise<void>;
+}
+
+export type AutocompleteApi<
+  TItem extends BaseItem,
+  TEvent = Event,
+  TMouseEvent = MouseEvent,
+  TKeyboardEvent = KeyboardEvent
+> = AutocompleteScopeApi<TItem> &
+  AutocompletePropGetters<TItem, TEvent, TMouseEvent, TKeyboardEvent>;

packages/autocomplete-core/src/types/AutocompleteCollection.ts

@@ -0,0 +1,12 @@
+import { BaseItem } from './AutocompleteApi';
+import { InternalAutocompleteSource } from './AutocompleteSource';
+
+export interface AutocompleteCollection<TItem extends BaseItem> {
+  source: InternalAutocompleteSource<TItem>;
+  items: TItem[];
+}
+
+export interface AutocompleteCollectionItemsArray<TItem extends BaseItem> {
+  source: InternalAutocompleteSource<TItem>;
+  items: TItem[][];
+}