@redhat-cloud-services/types 1.0.14-0 → 1.0.14

package/index.d.ts

@@ -4,247 +4,279 @@ import { Access } from '@redhat-cloud-services/rbac-client';
 import { AnalyticsBrowser } from '@segment/analytics-next';
 import { Method } from 'axios';
 import type { AxiosRequestConfig } from 'axios';
+
 export declare type HelpTopicLink = {
-    href: string;
-    text?: string;
-    newTab?: boolean;
-    isExternal?: boolean;
+  href: string;
+  text?: string;
+  newTab?: boolean;
+  isExternal?: boolean;
 };
+
 export declare type HelpTopic = {
-    name: string;
-    title: string;
-    tags: string[];
-    content: string;
-    links?: HelpTopicLink[];
+  name: string;
+  title: string;
+  tags: string[];
+  content: string;
+  links?: HelpTopicLink[];
 };
+
 export declare type PDFRequestPayload = {
-    manifestLocation: string;
-    scope: string;
-    module: string;
-    importName?: string;
-    fetchDataParams?: Record<string, any>;
+  manifestLocation: string;
+  scope: string;
+  module: string;
+  importName?: string;
+  fetchDataParams?: Record<string, any>;
 };
+
 export declare type PDFRequestOptions = {
-    payload: PDFRequestPayload;
-    filename?: string;
+  payload: PDFRequestPayload;
+  filename?: string;
 };
+
 type CreateAxiosRequest<T = any> = (service: string, config: AxiosRequestConfig) => Promise<T>;
-export type FetchData = (createAsyncRequest: CreateAxiosRequest) => Promise<any>;
-export type AsyncState<T = any> = {
-    data: T;
+
+type FetchData = (createAsyncRequest: CreateAxiosRequest) => Promise<any>;
+
+type AsyncState<T = any> = {
+  data: T;
 };
+
 declare type ChromeUser = {
-    entitlements: {
-        [key: string]: {
-            is_entitled: boolean;
-            is_trial: boolean;
-        };
+  entitlements: {
+    [key: string]: {
+      is_entitled: boolean;
+      is_trial: boolean;
     };
-    identity: {
-        account_number?: string;
-        org_id: string;
-        internal?: {
-            org_id: string;
-            account_id: string;
-        };
-        type: string;
-        user?: {
-            username: string;
-            email: string;
-            first_name: string;
-            last_name: string;
-            is_active: boolean;
-            is_internal: boolean;
-            is_org_admin: boolean;
-            locale: string;
-        };
+  };
+  identity: {
+    account_number?: string;
+    org_id: string;
+    internal?: {
+      org_id: string;
+      account_id: string;
+    };
+    type: string;
+    user?: {
+      username: string;
+      email: string;
+      first_name: string;
+      last_name: string;
+      is_active: boolean;
+      is_internal: boolean;
+      is_org_admin: boolean;
+      locale: string;
     };
+  };
 };
+
 export declare type VisibilityFunctions = {
-    isOrgAdmin: () => Promise<boolean>;
-    isActive: () => Promise<boolean>;
-    isInternal: () => Promise<boolean>;
-    isEntitled: (appName?: string) => Promise<{
-        [key: string]: boolean;
-    }>;
-    isProd: () => boolean;
-    isBeta: () => boolean;
-    isHidden: () => true;
-    withEmail: (toHave: string) => Promise<boolean>;
-    loosePermissions: (permissions: string[]) => Promise<boolean>;
-    hasPermissions: (permissions: string[]) => Promise<boolean>;
-    hasLocalStorage: (key: string, value: any) => boolean;
-    hasCookie: (key: string, value: any) => boolean;
-    apiRequest: (config: {
-        [key: string]: any;
-        url: string;
-        method?: Method;
-        accessor?: string;
-        matcher?: 'isEmpty' | 'isNotEmpty';
-    }) => Promise<boolean>;
-    featureFlag: (flagName: string, expectedValue: boolean) => boolean;
+  isOrgAdmin: () => Promise<boolean>;
+  isActive: () => Promise<boolean>;
+  isInternal: () => Promise<boolean>;
+  isEntitled: (appName?: string) => Promise<{ [key: string]: boolean }>;
+  isProd: () => boolean;
+  isBeta: () => boolean;
+  isHidden: () => true;
+  withEmail: (toHave: string) => Promise<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?: Method;
+    accessor?: string;
+    matcher?: 'isEmpty' | 'isNotEmpty';
+  }) => Promise<boolean>;
+  featureFlag: (flagName: string, expectedValue: boolean) => boolean;
 };
+
+/**
+ * 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;
+  href: string;
+  id: string;
+  navId: string;
+  type: string;
+  target?: HTMLAnchorElement | null;
 };
-export type AppNavigationCB = (navEvent: {
-    navId?: string;
-    domEvent: NavDOMEvent;
-}) => void;
+
+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;
+  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]): undefined | (() => void) | (() => undefined) | (() => boolean);
-export type EnableTopicsArgs = [{
-    names: string[];
-    append?: boolean;
-}] | string[];
+
+declare function OnChromeEvent<K extends 'APP_NAVIGATION' | 'NAVIGATION_TOGGLE' | 'GLOBAL_FILTER_UPDATE'>(
+  event: K,
+  callback: OnEventCallbacks[K]
+): undefined | (() => void) | (() => undefined) | (() => boolean);
+
+export type EnableTopicsArgs = [{ names: string[]; append?: boolean }] | string[];
+
 export type ChromeWsEventTypes = 'com.redhat.console.notifications.drawer';
 export type ChromeWsPayload<T> = {
-    data: T;
-    type: ChromeWsEventTypes;
-    source: string;
-    datacontenttype: string;
-    specversion: string;
-    time: string;
+  data: T;
+  type: ChromeWsEventTypes;
+  source: string;
+  datacontenttype: string;
+  specversion: string;
+  time: string;
 };
 export type ChromeWsEventListener<T> = (event: ChromeWsPayload<T>) => void;
 export type UnSubscribeFromChromeWsEvent = () => void;
 export type AddChromeWsEventListener = <T>(type: ChromeWsEventTypes, listener: ChromeWsEventListener<T>) => UnSubscribeFromChromeWsEvent;
+
 export interface ChromeAPI {
-    $internal: any;
-    addWsEventListener: AddChromeWsEventListener;
-    initialized: boolean;
-    experimentalApi: boolean;
-    isFedramp: boolean;
-    usePendoFeedback: () => void;
-    toggleFeedbackModal: (isOpen: boolean) => void;
-    toggleDebuggerModal: (isOpen: boolean) => void;
-    enableDebugging: () => void;
-    quickStarts: {
-        version: number;
-        set: (key: string, quickstarts: QuickStart[]) => void;
-        toggle: (quickstartId: string) => void;
-        Catalog: typeof QuickStartCatalogPage;
-        activateQuickstart: (name: string) => Promise<void>;
-    };
-    chromeHistory: History;
-    isProd: () => boolean;
-    appAction: (action: string) => void;
-    appNavClick: (payload: any) => void;
-    appObjectId: (objectId: string) => void;
-    auth: {
-        doOffline?: () => void;
-        getOfflineToken: () => Promise<any>;
-        getRefreshToken: () => Promise<string>;
-        getToken: () => Promise<string | undefined>;
-        getUser: () => Promise<ChromeUser | void>;
-        login: () => Promise<any>;
-        logout: () => void;
-        qe: any;
-        reAuthWithScopes: (...scopes: string[]) => Promise<void>;
-    };
-    createCase: (fields: Record<string, unknown>) => void;
-    enable: {
-        iqe: () => void;
-        remediationsDebug: () => void;
-        invTags: () => void;
-        shortSession: () => void;
-        jwtDebug: () => void;
-        reduxDebug: () => void;
-        forcePendo: () => void;
-        allDetails: () => void;
-        inventoryDrawer: () => void;
-        globalFilter: () => void;
-        appFilter: () => void;
-        contextSwitcher: () => void;
-        quickstartsDebug: () => void;
-    };
-    forceDemo: () => void;
-    getApp: () => string;
-    getBundle: () => string;
-    getBundleData: () => {
-        bundleId: string;
-        bundleTitle: string;
-    };
-    getEnvironment: () => string;
-    getEnvironmentDetails: () => undefined | {
+  /** @deprecated will be removed from useChrome hook */
+  $internal: any;
+  addWsEventListener: AddChromeWsEventListener;
+  initialized: boolean;
+  experimentalApi: boolean;
+  /** Return true if current environment is fedramp */
+  isFedramp: boolean;
+  usePendoFeedback: () => void;
+  toggleFeedbackModal: (isOpen: boolean) => void;
+  toggleDebuggerModal: (isOpen: boolean) => void;
+  enableDebugging: () => void;
+  quickStarts: {
+    version: number;
+    set: (key: string, quickstarts: QuickStart[]) => void;
+    toggle: (quickstartId: string) => void;
+    Catalog: typeof QuickStartCatalogPage;
+    activateQuickstart: (name: string) => Promise<void>;
+  };
+  chromeHistory: History;
+  isProd: () => boolean;
+  appAction: (action: string) => void;
+  appNavClick: (payload: any) => void;
+  appObjectId: (objectId: string) => void;
+  auth: {
+    doOffline?: () => void;
+    getOfflineToken: () => Promise<any>;
+    getRefreshToken: () => Promise<string>;
+    getToken: () => Promise<string | undefined>;
+    getUser: () => Promise<ChromeUser | void>;
+    login: () => Promise<any>;
+    logout: () => void;
+    /** @deprecated will be removed from useChrome hook */
+    qe: any;
+    reAuthWithScopes: (...scopes: string[]) => Promise<void>;
+  };
+  createCase: (fields: Record<string, unknown>) => void;
+  enable: {
+    iqe: () => void;
+    remediationsDebug: () => void;
+    invTags: () => void;
+    shortSession: () => void;
+    jwtDebug: () => void;
+    reduxDebug: () => void;
+    forcePendo: () => void;
+    allDetails: () => void;
+    inventoryDrawer: () => void;
+    globalFilter: () => void;
+    appFilter: () => void;
+    contextSwitcher: () => void;
+    quickstartsDebug: () => void;
+  };
+  forceDemo: () => void;
+  getApp: () => string;
+  getBundle: () => string;
+  getBundleData: () => {
+    bundleId: string;
+    bundleTitle: string;
+  };
+  getEnvironment: () => string;
+  getEnvironmentDetails: () =>
+    | undefined
+    | {
         url: string[];
         sso: string;
         portal: string;
+      };
+  getUserPermissions: (applicationName?: string, disableCache?: boolean) => Promise<Access[]>;
+  globalFilterScope: (scope: string) => {
+    type: string;
+    payload: string;
+  };
+  getAvailableBundles: () => { id: string; title: string }[];
+  helpTopics: {
+    addHelpTopics: (topics: HelpTopic[], enabled?: boolean) => void;
+    enableTopics: (...topicsNames: EnableTopicsArgs) => Promise<HelpTopic[]>;
+    disableTopics: (...topicsNames: string[]) => void;
+    setActiveTopic: (name: string) => Promise<void>;
+    closeHelpTopic: () => void;
+  };
+  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>;
+  /**  @deprecated this function has no effect */
+  init: () => void;
+  isBeta: () => boolean;
+  isChrome2: boolean;
+  isDemo: () => boolean;
+  isPenTest: () => boolean;
+  /** TODO: create function typings */
+  mapGlobalFilter: (...args: any[]) => any;
+  /** @deprecated this function has no effect. */
+  navigation: () => void;
+  /**
+   * 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) => {
+    type: string;
+    payload: {
+      isHidden: boolean;
     };
-    getUserPermissions: (applicationName?: string, disableCache?: boolean) => Promise<Access[]>;
-    globalFilterScope: (scope: string) => {
-        type: string;
-        payload: string;
-    };
-    getAvailableBundles: () => {
-        id: string;
-        title: string;
-    }[];
-    helpTopics: {
-        addHelpTopics: (topics: HelpTopic[], enabled?: boolean) => void;
-        enableTopics: (...topicsNames: EnableTopicsArgs) => Promise<HelpTopic[]>;
-        disableTopics: (...topicsNames: string[]) => void;
-        setActiveTopic: (name: string) => Promise<void>;
-        closeHelpTopic: () => void;
-    };
-    hideGlobalFilter: (isHidden: boolean) => void;
-    identifyApp: (data: any, appTitle?: string, noSuffix?: boolean) => Promise<any>;
-    init: () => void;
-    isBeta: () => boolean;
-    isChrome2: boolean;
-    isDemo: () => boolean;
-    isPenTest: () => boolean;
-    mapGlobalFilter: (...args: any[]) => any;
-    navigation: () => void;
-    on: typeof OnChromeEvent;
-    registerModule: (module: string, manifest: string) => void;
-    removeGlobalFilter: (isHidden: boolean) => {
-        type: string;
-        payload: {
-            isHidden: boolean;
-        };
-    };
-    updateDocumentTitle: (title: string, noSuffix?: boolean) => void;
-    visibilityFunctions: VisibilityFunctions;
-    isAnsibleTrialFlagActive: () => boolean | undefined;
-    setAnsibleTrialFlag: () => void;
-    clearAnsibleTrialFlag: () => void;
-    segment: {
-        setPageMetadata: (pageOptions?: Record<string, unknown>) => void;
-    };
-    analytics: AnalyticsBrowser;
-    useGlobalFilter: <T = undefined>(callback: (selectedTags?: {
+  };
+  updateDocumentTitle: (title: string, noSuffix?: boolean) => void;
+  visibilityFunctions: VisibilityFunctions;
+  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]: {
-            [key: string]: {
-                isSelected?: boolean;
-                value: string;
-                item?: {
-                    tagKey?: string;
-                    tagValue?: string;
-                };
-                group?: {
-                    items?: unknown;
-                };
-            };
+          isSelected?: boolean;
+          value: string;
+          item?: {
+            tagKey?: string;
+            tagValue?: string;
+          };
+          group?: {
+            items?: unknown;
+          };
         };
-    }) => T) => T;
-    enablePackagesDebug: () => void;
-    requestPdf: (options: PDFRequestOptions) => Promise<void>;
+      };
+    }) => T
+  ) => T;
+  enablePackagesDebug: () => void;
+  requestPdf: (options: PDFRequestOptions) => Promise<void>;
 }
+
 declare global {
-    interface Window {
-        insights: {
-            chrome: ChromeAPI;
-        };
-    }
+  interface Window {
+    insights: {
+      chrome: ChromeAPI;
+    };
+  }
 }
-export {};

package/package.json

@@ -1,26 +1,25 @@
 {
-  "name": "@redhat-cloud-services/types",
-  "description": "TypeScript definitions for @redhat-cloud-services common typings",
-  "version": "1.0.14-0",
-  "main": "index.d.ts",
-  "types": "index.d.ts",
-  "publishConfig": {
-    "access": "public"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/RedHatInsights/frontend-components.git",
-    "directory": "packages/types"
-  },
-  "scripts": {},
-  "devDependencies": {
-    "@patternfly/quickstarts": "^5.0.0",
-    "@redhat-cloud-services/rbac-client": "^1.0.111 || 2.x",
-    "history": "^4.10.1",
-    "glob": "10.3.3",
-    "@segment/analytics-next": "^1.43.2"
-  },
-  "author": "",
-  "license": "Apache-2.0",
-  "type": "commonjs"
+    "name": "@redhat-cloud-services/types",
+    "description": "TypeScript definitions for @redhat-cloud-services common typings",
+    "version": "1.0.14",
+    "main": "",
+    "types": "index.d.ts",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/RedHatInsights/frontend-components.git",
+        "directory": "packages/types"
+    },
+    "scripts": {},
+    "devDependencies": {
+        "@patternfly/quickstarts": "^5.0.0",
+        "@redhat-cloud-services/rbac-client": "^1.0.111 || 2.x",
+        "history": "^4.10.1",
+        "glob": "10.3.3",
+        "@segment/analytics-next": "^1.43.2"
+    },
+    "author": "",
+    "license": "Apache-2.0"
 }

package/tsconfig.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "module": "commonjs",
+        "lib": [
+            "es6"
+        ],
+        "noImplicitAny": false,
+        "noImplicitThis": true,
+        "strictNullChecks": true,
+        "strictFunctionTypes": true,
+        "types": [],
+        "noEmit": true,
+        "forceConsistentCasingInFileNames": true
+    },
+    "files": [
+        "index.d.ts",
+    ]
+}

package/index.js

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../packages/types/index.ts"],"names":[],"mappings":""}