Generic type for the search options.

Signed-off-by: Akos Kitta <a.kitta@arduino.cc>
arduino · francescospissu · Aug 27, 2022 · Aug 27, 2022 · Aug 27, 2022 · Aug 27, 2022
commit 2b0d3976fa4743631d3abf86084360e522fc246f
diff --git a/arduino-ide-extension/src/browser/boards/boards-list-widget.ts b/arduino-ide-extension/src/browser/boards/boards-list-widget.ts
@@ -4,6 +4,7 @@ import {
   postConstruct,
 } from '@theia/core/shared/inversify';
 import {
+  BoardSearch,
   BoardsPackage,
   BoardsService,
 } from '../../common/protocol/boards-service';
@@ -12,7 +13,7 @@ import { ListItemRenderer } from '../widgets/component-list/list-item-renderer';
 import { nls } from '@theia/core/lib/common';
 
 @injectable()
-export class BoardsListWidget extends ListWidget<BoardsPackage> {
+export class BoardsListWidget extends ListWidget<BoardsPackage, BoardSearch> {
   static WIDGET_ID = 'boards-list-widget';
   static WIDGET_LABEL = nls.localize('arduino/boardsManager', 'Boards Manager');
 

diff --git a/arduino-ide-extension/src/browser/boards/boards-widget-frontend-contribution.ts b/arduino-ide-extension/src/browser/boards/boards-widget-frontend-contribution.ts
@@ -1,10 +1,16 @@
 import { injectable } from '@theia/core/shared/inversify';
 import { BoardsListWidget } from './boards-list-widget';
-import { BoardsPackage } from '../../common/protocol/boards-service';
+import type {
+  BoardSearch,
+  BoardsPackage,
+} from '../../common/protocol/boards-service';
 import { ListWidgetFrontendContribution } from '../widgets/component-list/list-widget-frontend-contribution';
 
 @injectable()
-export class BoardsListWidgetFrontendContribution extends ListWidgetFrontendContribution<BoardsPackage> {
+export class BoardsListWidgetFrontendContribution extends ListWidgetFrontendContribution<
+  BoardsPackage,
+  BoardSearch
+> {
   constructor() {
     super({
       widgetId: BoardsListWidget.WIDGET_ID,

diff --git a/arduino-ide-extension/src/browser/library/library-list-widget.ts b/arduino-ide-extension/src/browser/library/library-list-widget.ts
@@ -1,10 +1,15 @@
-import { injectable, postConstruct, inject } from '@theia/core/shared/inversify';
+import {
+  injectable,
+  postConstruct,
+  inject,
+} from '@theia/core/shared/inversify';
 import { Message } from '@theia/core/shared/@phosphor/messaging';
 import { addEventListener } from '@theia/core/lib/browser/widgets/widget';
 import { DialogProps } from '@theia/core/lib/browser/dialogs';
 import { AbstractDialog } from '../theia/dialogs/dialogs';
 import {
   LibraryPackage,
+  LibrarySearch,
   LibraryService,
 } from '../../common/protocol/library-service';
 import { ListWidget } from '../widgets/component-list/list-widget';
@@ -13,7 +18,10 @@ import { ListItemRenderer } from '../widgets/component-list/list-item-renderer';
 import { nls } from '@theia/core/lib/common';
 
 @injectable()
-export class LibraryListWidget extends ListWidget<LibraryPackage> {
+export class LibraryListWidget extends ListWidget<
+  LibraryPackage,
+  LibrarySearch
+> {
   static WIDGET_ID = 'library-list-widget';
   static WIDGET_LABEL = nls.localize(
     'arduino/library/title',
@@ -41,7 +49,9 @@ export class LibraryListWidget extends ListWidget<LibraryPackage> {
   protected override init(): void {
     super.init();
     this.toDispose.pushAll([
-      this.notificationCenter.onLibraryDidInstall(() => this.refresh(undefined)),
+      this.notificationCenter.onLibraryDidInstall(() =>
+        this.refresh(undefined)
+      ),
       this.notificationCenter.onLibraryDidUninstall(() =>
         this.refresh(undefined)
       ),

diff --git a/arduino-ide-extension/src/browser/widgets/component-list/filterable-list-container.tsx b/arduino-ide-extension/src/browser/widgets/component-list/filterable-list-container.tsx
@@ -16,23 +16,24 @@ import { ResponseServiceClient } from '../../../common/protocol';
 import { nls } from '@theia/core/lib/common';
 
 export class FilterableListContainer<
-  T extends ArduinoComponent
+  T extends ArduinoComponent,
+  S extends Searchable.Options
 > extends React.Component<
-  FilterableListContainer.Props<T>,
-  FilterableListContainer.State<T>
+  FilterableListContainer.Props<T, S>,
+  FilterableListContainer.State<T, S>
 > {
-  constructor(props: Readonly<FilterableListContainer.Props<T>>) {
+  constructor(props: Readonly<FilterableListContainer.Props<T, S>>) {
     super(props);
     this.state = {
-      filterText: '',
+      searchOptions: { query: '' } as S,
       items: [],
     };
   }
 
   override componentDidMount(): void {
     this.search = debounce(this.search, 500);
-    this.handleFilterTextChange('');
-    this.props.filterTextChangeEvent(this.handleFilterTextChange.bind(this));
+    this.handleQueryChange('');
+    this.props.filterTextChangeEvent(this.handleQueryChange.bind(this));
   }
 
   override componentDidUpdate(): void {
@@ -59,8 +60,8 @@ export class FilterableListContainer<
     return (
       <SearchBar
         resolveFocus={this.props.resolveFocus}
-        filterText={this.state.filterText}
-        onFilterTextChanged={this.handleFilterTextChange}
+        filterText={this.state.searchOptions.query ?? ''}
+        onFilterTextChanged={this.handleQueryChange}
       />
     );
   }
@@ -79,17 +80,21 @@ export class FilterableListContainer<
     );
   }
 
-  protected handleFilterTextChange = (
-    filterText: string = this.state.filterText
+  protected handleQueryChange = (
+    query: string = this.state.searchOptions.query ?? ''
   ): void => {
-    this.setState({ filterText });
-    this.search(filterText);
+    const newSearchOptions = {
+      ...this.state.searchOptions,
+      query,
+    };
+    this.setState({ searchOptions: newSearchOptions });
+    this.search(newSearchOptions);
   };
 
-  protected search(query: string): void {
+  protected search(searchOptions: S): void {
     const { searchable } = this.props;
     searchable
-      .search({ query: query.trim() })
+      .search(searchOptions)
       .then((items) => this.setState({ items: this.sort(items) }));
   }
 
@@ -117,7 +122,7 @@ export class FilterableListContainer<
         ` ${item.name}:${version}`,
       run: ({ progressId }) => install({ item, progressId, version }),
     });
-    const items = await searchable.search({ query: this.state.filterText });
+    const items = await searchable.search(this.state.searchOptions);
     this.setState({ items: this.sort(items) });
   }
 
@@ -145,15 +150,18 @@ export class FilterableListContainer<
         }`,
       run: ({ progressId }) => uninstall({ item, progressId }),
     });
-    const items = await searchable.search({ query: this.state.filterText });
+    const items = await searchable.search(this.state.searchOptions);
     this.setState({ items: this.sort(items) });
   }
 }
 
 export namespace FilterableListContainer {
-  export interface Props<T extends ArduinoComponent> {
-    readonly container: ListWidget<T>;
-    readonly searchable: Searchable<T>;
+  export interface Props<
+    T extends ArduinoComponent,
+    S extends Searchable.Options
+  > {
+    readonly container: ListWidget<T, S>;
+    readonly searchable: Searchable<T, S>;
     readonly itemLabel: (item: T) => string;
     readonly itemDeprecated: (item: T) => boolean;
     readonly itemRenderer: ListItemRenderer<T>;
@@ -181,8 +189,8 @@ export namespace FilterableListContainer {
     readonly commandService: CommandService;
   }
 
-  export interface State<T> {
-    filterText: string;
+  export interface State<T, S extends Searchable.Options> {
+    searchOptions: S;
     items: T[];
   }
 }
diff --git a/...ino-ide-extension/src/browser/widgets/component-list/list-widget-frontend-contribution.ts b/...ino-ide-extension/src/browser/widgets/component-list/list-widget-frontend-contribution.ts
@@ -3,13 +3,20 @@ import { FrontendApplicationContribution } from '@theia/core/lib/browser/fronten
 import { AbstractViewContribution } from '@theia/core/lib/browser/shell/view-contribution';
 import { ArduinoComponent } from '../../../common/protocol/arduino-component';
 import { ListWidget } from './list-widget';
+import { Searchable } from '../../../common/protocol';
 
 @injectable()
-export abstract class ListWidgetFrontendContribution<T extends ArduinoComponent>
-  extends AbstractViewContribution<ListWidget<T>>
+export abstract class ListWidgetFrontendContribution<
+    T extends ArduinoComponent,
+    S extends Searchable.Options
+  >
+  extends AbstractViewContribution<ListWidget<T, S>>
   implements FrontendApplicationContribution
 {
-  async initializeLayout(): Promise<void> {}
+  async initializeLayout(): Promise<void> {
+    // TS requires at least one method from `FrontendApplicationContribution`.
+    // Expected to be empty.
+  }
 
   override registerMenus(): void {
     // NOOP

diff --git a/arduino-ide-extension/src/browser/widgets/component-list/list-widget.tsx b/arduino-ide-extension/src/browser/widgets/component-list/list-widget.tsx
@@ -22,7 +22,8 @@ import { NotificationCenter } from '../../notification-center';
 
 @injectable()
 export abstract class ListWidget<
-  T extends ArduinoComponent
+  T extends ArduinoComponent,
+  S extends Searchable.Options
 > extends ReactWidget {
   @inject(MessageService)
   protected readonly messageService: MessageService;
@@ -50,7 +51,7 @@ export abstract class ListWidget<
    */
   protected firstActivate = true;
 
-  constructor(protected options: ListWidget.Options<T>) {
+  constructor(protected options: ListWidget.Options<T, S>) {
     super();
     const { id, label, iconClass } = options;
     this.id = id;
@@ -129,7 +130,7 @@ export abstract class ListWidget<
 
   render(): React.ReactNode {
     return (
-      <FilterableListContainer<T>
+      <FilterableListContainer<T, S>
         container={this}
         resolveFocus={this.onFocusResolved}
         searchable={this.options.searchable}
@@ -162,12 +163,15 @@ export abstract class ListWidget<
 }
 
 export namespace ListWidget {
-  export interface Options<T extends ArduinoComponent> {
+  export interface Options<
+    T extends ArduinoComponent,
+    S extends Searchable.Options
+  > {
     readonly id: string;
     readonly label: string;
     readonly iconClass: string;
     readonly installable: Installable<T>;
-    readonly searchable: Searchable<T>;
+    readonly searchable: Searchable<T, S>;
     readonly itemLabel: (item: T) => string;
     readonly itemDeprecated: (item: T) => boolean;
     readonly itemRenderer: ListItemRenderer<T>;

diff --git a/arduino-ide-extension/src/common/protocol/boards-service.ts b/arduino-ide-extension/src/common/protocol/boards-service.ts
@@ -131,7 +131,7 @@ export const BoardsServicePath = '/services/boards-service';
 export const BoardsService = Symbol('BoardsService');
 export interface BoardsService
   extends Installable<BoardsPackage>,
-    Searchable<BoardsPackage> {
+    Searchable<BoardsPackage, BoardSearch> {
   getState(): Promise<AvailablePorts>;
   getBoardDetails(options: { fqbn: string }): Promise<BoardDetails | undefined>;
   getBoardPackage(options: { id: string }): Promise<BoardsPackage | undefined>;
@@ -145,6 +145,22 @@ export interface BoardsService
   }): Promise<BoardUserField[]>;
 }
 
+export interface BoardSearch extends Searchable.Options {
+  readonly type?: BoardSearch.Type;
+}
+export namespace BoardSearch {
+  export const TypeLiterals = [
+    'All',
+    'Updatable',
+    'Arduino',
+    'Contributed',
+    'Arduino Certified',
+    'Partner',
+    'Arduino@Heart',
+  ] as const;
+  export type Type = typeof TypeLiterals[number];
+}
+
 export interface Port {
   readonly address: string;
   readonly addressLabel: string;

diff --git a/arduino-ide-extension/src/common/protocol/library-service.ts b/arduino-ide-extension/src/common/protocol/library-service.ts
@@ -6,7 +6,7 @@ export const LibraryServicePath = '/services/library-service';
 export const LibraryService = Symbol('LibraryService');
 export interface LibraryService
   extends Installable<LibraryPackage>,
-    Searchable<LibraryPackage> {
+    Searchable<LibraryPackage, LibrarySearch> {
   list(options: LibraryService.List.Options): Promise<LibraryPackage[]>;
   search(options: LibrarySearch): Promise<LibraryPackage[]>;
   /**

diff --git a/arduino-ide-extension/src/common/protocol/searchable.ts b/arduino-ide-extension/src/common/protocol/searchable.ts
@@ -1,5 +1,5 @@
-export interface Searchable<T> {
-  search(options: Searchable.Options): Promise<T[]>;
+export interface Searchable<T, O extends Searchable.Options> {
+  search(options: O): Promise<T[]>;
 }
 export namespace Searchable {
   export interface Options {