@redhat-cloud-services/types 0.0.12 → 0.0.13

package/index.d.ts

@@ -1,6 +1,7 @@
-import { QuickStartCatalogPage } from '@patternfly/quickstarts';
+import { QuickStart, QuickStartCatalogPage } from '@patternfly/quickstarts';
 import { History } from 'history';
 import { Access } from '@redhat-cloud-services/rbac-client';
+import { AnalyticsBrowser } from '@segment/analytics-next';
 
 export declare type HelpTopicLink = {
   href: string;
@@ -99,13 +100,13 @@ export interface ChromeAPI {
   initialized: boolean;
   experimentalApi: boolean;
   /** Return true if current environment is fedramp */
-  isFedramp: () => boolean;
+  isFedramp: boolean;
   usePendoFeedback: () => void;
   toggleFeedbackModal: (isOpen: boolean) => void;
-  quickstarts: {
+  quickStarts: {
     version: number;
-    set: (key: string, qs: any[]) => void;
-    toogle: (quickstartId: string) => void;
+    updateQuickStarts: (key: string, quickstarts: QuickStart[]) => void;
+    toggle: (quickstartId: string) => void;
     Catalog: typeof QuickStartCatalogPage;
   };
   chromeHistory: History;
@@ -155,9 +156,9 @@ export interface ChromeAPI {
   };
   helpTopics: {
     addHelpTopics: (topics: HelpTopic[], enabled?: boolean) => void;
-    enableTopics: (...topicsNames: string[]) => Promise<void>;
+    enableTopics: (...topicsNames: string[]) => Promise<void[]>;
     disableTopics: (...topicsNames: string[]) => void;
-    setActiveTopic: (name: string) => void;
+    setActiveTopic: (name: string) => Promise<void>;
     closeHelpTopic: () => void;
   };
   hideGlobalFilter: (isHidden: boolean) => void;
@@ -193,6 +194,28 @@ export interface ChromeAPI {
   isAnsibleTrialFlagActive: () => boolean | undefined;
   setAnsibleTrialFlag: () => void;
   clearAnsibleTrialFlag: () => void;
+  // segment API
+  segment: {
+    setPageMetadata: (pageOptions?: Record<string, unknown>) => void;
+  };
+  analytics: AnalyticsBrowser;
+  useGlobalFilter: <T = undefined>(
+    callback: (selectedTags?: {
+      [key: string]: {
+        [key: string]: {
+          isSelected?: boolean;
+          value: string;
+          item?: {
+            tagKey?: string;
+            tagValue?: string;
+          };
+          group?: {
+            items?: unknown;
+          };
+        };
+      };
+    }) => T
+  ) => T;
 }
 
 declare global {

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@redhat-cloud-services/types",
     "description": "TypeScript definitions for @redhat-cloud-services common typings",
-    "version": "0.0.12",
+    "version": "0.0.13",
     "main": "",
     "types": "index.d.ts",
     "publishConfig": {
@@ -16,7 +16,8 @@
     "devDependencies": {
         "@patternfly/quickstarts": "^2.3.1",
         "@redhat-cloud-services/rbac-client": "^1.0.111",
-        "history": "^4.10.1"
+        "history": "^4.10.1",
+        "@segment/analytics-next": "^1.43.2"
     },
     "author": "",
     "license": "Apache-2.0"