@openfin/workspace 20.2.4 → 20.3.0

package/common/src/hooks/useSystemSchemeCheck.d.ts

@@ -1,13 +0,0 @@
-import { ColorSchemeType } from '@openfin/ui-library';
-/**
- * Custom hook that checks the system color scheme and provides information about the current scheme.
- *
- * @returns An object containing the current color scheme, system color scheme, and a boolean indicating if the scheme is dark.
- */
-interface SystemSchemeCheck {
-    currentScheme: Omit<ColorSchemeType, 'system'>;
-    systemScheme: Omit<ColorSchemeType, 'system'>;
-    isSchemeDark: boolean;
-}
-declare function useSystemSchemeCheck(): SystemSchemeCheck;
-export default useSystemSchemeCheck;

package/common/src/slices/environment.d.ts

@@ -1,22 +0,0 @@
-export interface EnvironmentRootState {
-    environment: {
-        isWindows: boolean;
-    };
-}
-export declare const getEnvironment: import("@reduxjs/toolkit").AsyncThunk<boolean, void, {}>;
-export declare const environmentSlice: import("@reduxjs/toolkit").Slice<{
-    isWindows: boolean;
-}, {
-    setEnvironment: (state: import("immer/dist/internal").WritableDraft<{
-        isWindows: boolean;
-    }>, action: {
-        payload: any;
-        type: string;
-    }) => void;
-}, "environment">;
-export declare const setEnvironment: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>;
-export declare const selectIsWindows: (state: EnvironmentRootState) => boolean;
-declare const _default: import("redux").Reducer<{
-    isWindows: boolean;
-}>;
-export default _default;

package/common/src/slices/target-theming.d.ts

@@ -1,56 +0,0 @@
-import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
-import type { ComputedTheme } from '../api/theming';
-export interface TargetThemingRootState {
-    targetTheming: {
-        isFetchingTheme: boolean;
-        currentTheme: ComputedTheme | undefined;
-        hasTriedFetch: boolean;
-        currentScheme: ColorSchemeOptionType | undefined;
-    };
-}
-export declare const targetThemingSlice: import("@reduxjs/toolkit").Slice<{
-    isFetchingTheme: boolean;
-    currentTheme: ComputedTheme | undefined;
-    hasTriedFetch: boolean;
-    currentScheme: ColorSchemeOptionType | undefined;
-}, {
-    setTheme: (state: import("immer/dist/internal").WritableDraft<{
-        isFetchingTheme: boolean;
-        currentTheme: ComputedTheme | undefined;
-        hasTriedFetch: boolean;
-        currentScheme: ColorSchemeOptionType | undefined;
-    }>, action: {
-        payload: any;
-        type: string;
-    }) => void;
-    setIsFetchingTheme: (state: import("immer/dist/internal").WritableDraft<{
-        isFetchingTheme: boolean;
-        currentTheme: ComputedTheme | undefined;
-        hasTriedFetch: boolean;
-        currentScheme: ColorSchemeOptionType | undefined;
-    }>, action: {
-        payload: any;
-        type: string;
-    }) => void;
-    setCurrentScheme: (state: import("immer/dist/internal").WritableDraft<{
-        isFetchingTheme: boolean;
-        currentTheme: ComputedTheme | undefined;
-        hasTriedFetch: boolean;
-        currentScheme: ColorSchemeOptionType | undefined;
-    }>, action: {
-        payload: any;
-        type: string;
-    }) => void;
-}, "targetTheming">;
-export declare const setTheme: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>, setIsFetchingTheme: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>, setCurrentScheme: import("@reduxjs/toolkit").ActionCreatorWithPayload<any, string>;
-export declare const selectTargetTheming: (state: TargetThemingRootState) => ComputedTheme;
-export declare const selectCurrentScheme: (state: TargetThemingRootState) => ColorSchemeOptionType;
-export declare const selectHasTriedFetch: (state: TargetThemingRootState) => boolean;
-export declare const selectIsFetchingTheme: (state: TargetThemingRootState) => boolean;
-declare const _default: import("redux").Reducer<{
-    isFetchingTheme: boolean;
-    currentTheme: ComputedTheme;
-    hasTriedFetch: boolean;
-    currentScheme: ColorSchemeOptionType;
-}>;
-export default _default;

package/common/src/styles/svg-icons.d.ts

@@ -1,7 +0,0 @@
-/// <reference types="react" />
-export declare const StyledIcon: import("styled-components").StyledComponent<import("react").ForwardRefExoticComponent<import("@openfin/ui-library").IconProps & import("react").RefAttributes<HTMLDivElement>>, import("styled-components").DefaultTheme, {
-    disabled?: boolean;
-    isEnterprise?: boolean;
-    windowFocused?: boolean;
-}, never>;
-export declare const ThemedSVG: import("styled-components").StyledComponent<"svg", import("styled-components").DefaultTheme, {}, never>;

package/common/src/utils/a11y/index.d.ts

@@ -1,3 +0,0 @@
-export type HTMLElementWithAria = HTMLElement & {
-    ariaLabel: string | null;
-};

package/common/src/utils/bookmark-item-context-menu.d.ts

@@ -1,8 +0,0 @@
-import { OpenFin } from '@openfin/core';
-import { BookmarkItemContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
-import { BookmarkFolder } from './bookmarks';
-export declare const getSortedBookmarkFoldersContextMenuOptions: (bookmarkFolders: BookmarkFolder[], checkedNodeId: string, separators?: {
-    afterAllBookmarks?: boolean;
-    afterFavorites?: boolean;
-}) => BookmarkItemContextMenuItemTemplate[];
-export declare const getBookmarkItemContextMenuTemplate: (callerIdentity: OpenFin.Identity, bookmarkId: string) => Promise<BookmarkItemContextMenuItemTemplate[]>;

package/common/src/utils/bookmarks.d.ts

@@ -1,16 +0,0 @@
-import { BookmarkNode } from '../../../common/src/api/pages/shapes';
-export declare const ALL_BOOKMARKS_FOLDER_TITLE = "_ALL_BOOKMARKS_";
-export declare const FAVORITES_FOLDER_TITLE = "_FAVORITES_";
-export type BookmarkFolder = {
-    id: string;
-    title: string;
-};
-export type CategorizedBookmarkSearchResults = {
-    bookmarksInFolder: BookmarkNode[];
-    bookmarksOutsideFolder: BookmarkNode[];
-};
-export declare const getBookmarkNodeTitle: (title: string) => string;
-export declare const categorizeSearchResults: (bookmarks: BookmarkNode[], folderId: string) => CategorizedBookmarkSearchResults;
-export declare const sortBookmarks: (a: BookmarkNode, b: BookmarkNode) => number;
-export declare const collectFolders: (nodes: BookmarkNode[]) => BookmarkFolder[];
-export declare const getBookmarkFoldersList: (rootNode: BookmarkNode) => BookmarkFolder[];

package/common/src/utils/custom-logo.d.ts

@@ -1,16 +0,0 @@
-/**
- * Custom React hook to check the accessibility of a custom logo image.
- * This hook initiates an image load and returns a boolean value indicating
- * whether the image is accessible or not.
- *
- * @param customLogoUrl The URL of the custom logo to check. If undefined, the hook immediately returns false.
- * @returns A state value that is true if the custom logo is accessible and has loaded successfully, and false otherwise.
- * @example
- * ```jsx
- * function Component() {
- *   const logoAccessible = useCustomLogoAccessible('http://example.com/logo.png');
- *   return logoAccessible ? <img src='http://example.com/logo.png' /> : <DefaultLogo />;
- * }
- * ```
- */
-export declare const useCustomLogoAccessible: (customLogoUrl: string | undefined) => boolean;

package/common/src/utils/get-browser-window.d.ts

@@ -1,3 +0,0 @@
-import OpenFin from '@openfin/core';
-export declare const getBrowserWindow: () => Promise<import("@client-platform/shapes").BrowserWindowModule>;
-export declare const getBrowserWindowWithoutView: (browserIdentity?: OpenFin.Identity) => Promise<import("@client-platform/shapes").BrowserWindowModule>;

package/common/src/utils/interop.d.ts

@@ -1,30 +0,0 @@
-import type OpenFin from '@openfin/core';
-export declare enum InteropEventType {
-    JoinedContextGroup = "joined-context-group",
-    RemovedFromContextGroup = "removed-from-context-group"
-}
-type InteropEventPayload<E extends InteropEventType> = {
-    [InteropEventType.JoinedContextGroup]: {
-        viewIdentity: OpenFin.Identity;
-        contextGroupId: string;
-    };
-    [InteropEventType.RemovedFromContextGroup]: {
-        viewIdentity: OpenFin.Identity;
-    };
-}[E];
-export type InteropListener<EventType extends InteropEventType> = (payload: InteropEventPayload<EventType>) => void;
-/**
- * Returns contextGroup data.
- * @returns Promise<ContextGroup[]>
- */
-export declare function getContextGroups(): Promise<OpenFin.ContextGroupInfo[]>;
-export declare const joinContextGroup: (viewIdentity: OpenFin.Identity, contextGroupId: string) => Promise<void>;
-export declare const removeFromGroup: (viewIdentity: OpenFin.Identity) => Promise<void>;
-export declare function getViewContextGroupId(viewIdentity: OpenFin.Identity): Promise<string | null | undefined>;
-/**
- * Listen for interop events.
- * @param event the interop event to listen for.
- * @param listener the function to call when the event occurs.
- */
-export declare const addInteropListener: <Event_1 extends InteropEventType>(event: Event_1, listener: InteropListener<Event_1>) => Promise<void>;
-export {};

package/common/src/utils/navigate.d.ts

@@ -1,8 +0,0 @@
-import type OpenFin from '@openfin/core';
-import { ComponentName } from '../../../common/src/utils/usage-register';
-export interface NavigatePayload {
-    componentName: ComponentName;
-    platformIdentity: OpenFin.Identity;
-    providerId?: string;
-}
-export declare const navigateTo: (componentName: ComponentName, platformIdentity: OpenFin.Identity, providerId?: string) => Promise<void>;

package/common/src/utils/test-ids.d.ts

@@ -1,70 +0,0 @@
-/**
- * All data test ids used by the application.
- */
-/**
- * Test id for the card shown when search result list on any page is empty.
- */
-export declare const listEmptyCard = "list-empty-card";
-/**
- * Test id for the homepad list item component's title.
- */
-export declare const componentsHomepadListItemTitle = "components-homepad-list-item-title";
-/**
- * Test id for the home page nav hotkey button
- */
-export declare const homepadNavHotkeyButton = "components-homepad-nav-hotkey";
-/**
- * Test id for the home's logo custom icon.
- */
-export declare const homeLogoCustomIconId = "home-logo-custom-icon";
-/**
- * Test id for the Enterprise Browser's logo custom icon.
- */
-export declare const enterpriseCustomIconId = "enterprise-logo-custom-icon";
-/**
- * Test id for the browser's Page tab button.
- */
-export declare const browserPageButton = "browser-page-button-tab";
-/**
- * Test id for the browser's New Page plus button.
- */
-export declare const browserNewPageButton = "browser-new-page-button";
-/**
- * Test id for the browser's Save Modal button in the top menu.
- */
-export declare const browserSaveModalButton = "browser-save-modal-button";
-/**
- * Test id for the input in Save Modal popup window.
- */
-export declare const browserSaveModalPopupInput = "browser-save-modal-popup-input";
-/**
- * Test id for the Save button in Save Modal popup window.
- */
-export declare const browserSaveModalPopupSaveButton = "browser-save-modal-popup-save-button";
-/**
- * Cancel button in the Workspace route, e.g. one asking if you want to switch to newly created workspace
- */
-export declare const workspaceDialogueCancelButton = "workspace-dialogue-cancel-button";
-/**
- * Input element in the Workspace route in Home
- */
-export declare const homeWorkspaceSearchInput = "home-workspace-search-input";
-/**
- * Lock/Unlock Page button when the page is locked
- */
-export declare const browserLockButtonLockedState = "lock-button-locked-state";
-/**
- * Lock/Unlock Page button when the page is unlocked
- */
-export declare const browserLockButtonUnLockedState = "lock-button-unlocked-state";
-/**
- * Test id for QA Studio.
- */
-export declare const QAStudioTestIds: {
-    readonly homeApiPanel: "home-api-panel";
-    readonly notificationsApiPanel: "notifications-api-panel";
-    readonly storeApiPanel: "store-api-panel";
-    readonly dockApiPanel: "dock-api-panel";
-    readonly workspacePlatformApiPanel: "workspace-platform-api-panel";
-    readonly workspaceApiPanel: "workspace-api-panel";
-};

package/common/src/utils/url.d.ts

@@ -1 +0,0 @@
-export declare function trimUrl(url: string): string;