Lib search API

Signed-off-by: Akos Kitta <[email protected]>

Author: Akos Kitta

arduino-ide-extension/src/common/protocol/library-service.ts

@@ -8,6 +8,7 @@ export interface LibraryService
   extends Installable<LibraryPackage>,
     Searchable<LibraryPackage> {
   list(options: LibraryService.List.Options): Promise<LibraryPackage[]>;
+  search(options: LibrarySearch): Promise<LibraryPackage[]>;
   /**
    * When `installDependencies` is not set, it is `true` by default. If you want to skip the installation of required dependencies, set it to `false`.
    */
@@ -38,6 +39,38 @@ export interface LibraryService
   }): Promise<LibraryDependency[]>;
 }
 
+export interface LibrarySearch extends Searchable.Options {
+  readonly type?: LibrarySearch.Type;
+  readonly topic?: LibrarySearch.Topic;
+}
+export namespace LibrarySearch {
+  export const TypeLiterals = [
+    'All',
+    'Updatable',
+    'Installed',
+    'Arduino',
+    'Partner',
+    'Recommended',
+    'Contributed',
+    'Retired',
+  ] as const;
+  export type Type = typeof TypeLiterals[number];
+  export const TopicLiterals = [
+    'All',
+    'Communication',
+    'Data Processing',
+    'Data Storage',
+    'Device Control',
+    'Display',
+    'Others',
+    'Sensors',
+    'Signal Input/Output',
+    'Timing',
+    'Uncategorized',
+  ];
+  export type Topic = typeof TopicLiterals[number];
+}
+
 export namespace LibraryService {
   export namespace List {
     export interface Options {