@redhat-cloud-services/types 0.0.3 → 0.0.6

package/index.d.ts

@@ -55,6 +55,28 @@ declare type VisibilityFunctions = {
 /**
  * TODO: Once chrome is migrated to TS, sychronize with chrome typings
  */
+export type NavDOMEvent = {
+  href: string;
+  id: string;
+  navId: string;
+  type: string;
+  target?: HTMLAnchorElement | null;
+};
+
+export type AppNavigationCB = (navEvent: { navId?: string; domEvent: NavDOMEvent }) => void;
+export type GenericCB = (...args: unknown[]) => void;
+
+export type OnEventCallbacks = {
+  APP_NAVIGATION: AppNavigationCB;
+  NAVIGATION_TOGGLE: GenericCB;
+  GLOBAL_FILTER_UPDATE: GenericCB;
+};
+
+declare function OnChromeEvent<K extends 'APP_NAVIGATION' | 'NAVIGATION_TOGGLE' | 'GLOBAL_FILTER_UPDATE'>(
+  event: K,
+  callback: OnEventCallbacks[K]
+): () => void;
+
 export interface ChromeAPI {
   /** @deprecated will be removed from useChrome hook */
   $internal: any;
@@ -111,11 +133,14 @@ export interface ChromeAPI {
     portal: string;
   };
   getUserPermissions: (applicationName?: string, disableCache?: boolean) => Promise<Access[]>;
-  globalFilterScope: (scope?: string) => void;
-  hideGlobalFilter: (hide?: boolean) => void;
+  globalFilterScope: (scope: string) => {
+    type: string;
+    payload: string;
+  };
+  hideGlobalFilter: (isHidden: boolean) => void;
   /** @deprecated This function server no purpse. For document title update use "updateDocumentTitle" function instead. */
-  identifyApp: (data: any, appTitle?: string) => Promise<undefined>;
-  init: () => void;
+  identifyApp: (data: any, appTitle?: string, noSuffix?: boolean) => Promise<any>;
+  init: () => ChromeAPI;
   isBeta: () => boolean;
   isChrome2: boolean;
   isDemo: () => boolean;
@@ -124,11 +149,30 @@ export interface ChromeAPI {
   mapGlobalFilter: (...args: any[]) => any;
   /** @deprecated this function has no effect. */
   navigation: () => void;
-  /** TODO: Deprecate this function */
-  on: (...args: any[]) => any;
+  /**
+   * Example usage
+   * on<'APP_NAVIGATION'>('APP_NAVIGATION', (navEvent) => {
+   * navEvent.domEvent.href;
+   * navEvent.navId;
+   * });
+   */
+  on: typeof OnChromeEvent;
   registerModule: (module: string, manifest: string) => void;
   /** @duplicate of "hideGlobalFilter" TODO: deprecate this function */
-  removeGlobalFilter: (isHidden?: boolean) => void;
-  updateDocumentTitle: (title: string) => void;
+  removeGlobalFilter: (isHidden: boolean) => {
+    type: string;
+    payload: {
+      isHidden: boolean;
+    };
+  };
+  updateDocumentTitle: (title: string, noSuffix?: boolean) => void;
   visibilityFunctions: VisibilityFunctions;
 }
+
+declare global {
+  interface Window {
+    insights: {
+      chrome: ChromeAPI;
+    };
+  }
+}

package/package.json

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