@redhat-cloud-services/types 3.0.0 → 3.1.0

package/index.d.ts

@@ -22,6 +22,7 @@ export declare type PDFRequestPayload = {
     scope: string;
     module: string;
     importName?: string;
+    landscape?: boolean;
     fetchDataParams?: Record<string, any>;
     additionalData?: Record<string, any>;
 };
@@ -119,6 +120,25 @@ export type ChromeWsPayload<T> = {
 export type ChromeWsEventListener<T> = (event: ChromeWsPayload<T>) => void;
 export type UnSubscribeFromChromeWsEvent = () => void;
 export type AddChromeWsEventListener = <T>(type: ChromeWsEventTypes, listener: ChromeWsEventListener<T>) => UnSubscribeFromChromeWsEvent;
+export type SearchDataType = 'legacy' | 'generated';
+export interface SearchEntry {
+    id: string;
+    title: string;
+    description: string;
+    uri: string;
+    pathname: string;
+    bundleTitle: string;
+    altTitle?: string[];
+    icon?: string;
+    type: SearchDataType;
+}
+export interface ChromeSearchAPI {
+    fillStore: (type: SearchDataType, data: SearchEntry[]) => Promise<void>;
+    query: (term: string, type?: SearchDataType, env?: string, limit?: number) => Promise<SearchEntry[]>;
+    getAvailableTypes: () => SearchDataType[];
+    clearType: (type: SearchDataType) => Promise<void>;
+    getCachedData: (type: SearchDataType) => SearchEntry[] | undefined;
+}
 export type DrawerPanelActions = {
     setDrawerPanelContent: (data: {
         scope: string;
@@ -254,6 +274,7 @@ export interface ChromeAPI {
     enablePackagesDebug: () => void;
     requestPdf: (options: PDFRequestOptions) => Promise<void>;
     drawerActions: DrawerPanelActions;
+    search?: ChromeSearchAPI;
 }
 declare global {
     interface Window {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@redhat-cloud-services/types",
   "description": "TypeScript definitions for @redhat-cloud-services common typings.",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "main": "index.d.ts",
   "types": "index.d.ts",
   "publishConfig": {