@redhat-cloud-services/types 0.0.15 → 0.0.17

package/index.d.ts

@@ -2,6 +2,7 @@ import { QuickStart, QuickStartCatalogPage } from '@patternfly/quickstarts';
 import { History } from 'history';
 import { Access } from '@redhat-cloud-services/rbac-client';
 import { AnalyticsBrowser } from '@segment/analytics-next';
+import { Method } from 'axios';
 
 export declare type HelpTopicLink = {
   href: string;
@@ -50,23 +51,24 @@ declare type VisibilityFunctions = {
   isOrgAdmin: () => Promise<boolean>;
   isActive: () => Promise<boolean>;
   isInternal: () => Promise<boolean>;
-  isEntitled: () => Promise<boolean>;
+  isEntitled: (appName?: string) => Promise<{ [key: string]: boolean }>;
   isProd: () => boolean;
   isBeta: () => boolean;
   isHidden: () => true;
   withEmail: (toHave: string) => Promise<boolean>;
-  loosePermissions: (permissions: string[]) => boolean;
-  hasPermissions: (permissions: string[]) => boolean;
+  loosePermissions: (permissions: string[]) => Promise<boolean>;
+  hasPermissions: (permissions: string[]) => Promise<boolean>;
   hasLocalStorage: (key: string, value: any) => boolean;
   hasCookie: (key: string, value: any) => boolean;
   /** TODO: Extends FEC axios instance config */
   apiRequest: (config: {
     [key: string]: any;
     url: string;
-    method?: 'string';
+    method?: Method;
     accessor?: string;
     matcher?: 'isEmpty' | 'isNotEmpty';
   }) => Promise<boolean>;
+  featureFlag: (flagName: string, expectedValue: boolean) => boolean;
 };
 
 /**
@@ -94,6 +96,8 @@ declare function OnChromeEvent<K extends 'APP_NAVIGATION' | 'NAVIGATION_TOGGLE'
   callback: OnEventCallbacks[K]
 ): undefined | (() => void) | (() => undefined) | (() => boolean);
 
+export type EnableTopicsArgs = [{ names: string[]; append?: boolean }] | string[];
+
 export interface ChromeAPI {
   /** @deprecated will be removed from useChrome hook */
   $internal: any;
@@ -110,15 +114,15 @@ export interface ChromeAPI {
     Catalog: typeof QuickStartCatalogPage;
   };
   chromeHistory: History;
-  isProd: boolean;
+  isProd: () => boolean;
   appAction: (action: string) => void;
   appNavClick: (payload: any) => void;
   appObjectId: (objectId: string) => void;
   auth: {
     doOffline: () => void;
     getOfflineToken: () => Promise<any>;
-    getToken: () => Promise<string>;
-    getUser: () => Promise<ChromeUser>;
+    getToken: () => Promise<string | undefined>;
+    getUser: () => Promise<ChromeUser | void>;
     login: () => Promise<any>;
     logout: () => void;
     /** @deprecated will be removed from useChrome hook */
@@ -144,11 +148,13 @@ export interface ChromeAPI {
   getApp: () => string;
   getBundle: () => string;
   getEnvironment: () => string;
-  getEnvironmentDetails: () => {
-    url: string[];
-    sso: string;
-    portal: string;
-  };
+  getEnvironmentDetails: () =>
+    | undefined
+    | {
+        url: string[];
+        sso: string;
+        portal: string;
+      };
   getUserPermissions: (applicationName?: string, disableCache?: boolean) => Promise<Access[]>;
   globalFilterScope: (scope: string) => {
     type: string;
@@ -156,7 +162,7 @@ export interface ChromeAPI {
   };
   helpTopics: {
     addHelpTopics: (topics: HelpTopic[], enabled?: boolean) => void;
-    enableTopics: (...topicsNames: string[]) => Promise<HelpTopic[]>;
+    enableTopics: (...topicsNames: EnableTopicsArgs) => Promise<HelpTopic[]>;
     disableTopics: (...topicsNames: string[]) => void;
     setActiveTopic: (name: string) => Promise<void>;
     closeHelpTopic: () => void;
@@ -164,7 +170,8 @@ export interface ChromeAPI {
   hideGlobalFilter: (isHidden: boolean) => void;
   /** @deprecated This function server no purpse. For document title update use "updateDocumentTitle" function instead. */
   identifyApp: (data: any, appTitle?: string, noSuffix?: boolean) => Promise<any>;
-  init: () => ChromeAPI;
+  /**  @deprecated this function has no effect */
+  init: () => void;
   isBeta: () => boolean;
   isChrome2: boolean;
   isDemo: () => boolean;

package/package.json

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