@openfin/workspace 13.1.4 → 14.0.11

package/common/src/api/shapes/home.d.ts

@@ -0,0 +1,186 @@
+import { DispatchedSearchResult, HomeSearchListenerRequest, HomeSearchResult } from '../../../../client-api/src/shapes';
+import { HomeProviderInternal } from '../../../../common/src/api/provider';
+/**
+ * The ids of home providers that are built into Home.
+ */
+export declare const HomeBuiltInProviderID: {
+    /**
+     * Built in Home provider that provides commands.
+     */
+    readonly commands: "home-commands";
+};
+/**
+ * The ids of home providers that are built into Home.
+ */
+export declare const HomeBuiltInProviderUniqueID: {
+    /**
+     * Built in Home provider that provides commands.
+     */
+    readonly commands: string;
+};
+export declare const HOME_SEARCH_CHANNEL_NAME: "__search-openfin-browser-home-topic__";
+export type HomeClientApiDispatchRequest = {
+    providerId: string;
+    result: DispatchedSearchResult;
+};
+export type HomeClientApiSearchCloseRequest = {
+    id: string;
+};
+export type HomeClientApiDataRequest = {
+    id: string;
+    query: string;
+    context: any;
+    providerId: string;
+    targets: string[];
+};
+export interface HomeInternalDataResponse extends SearchResponse {
+    id: string;
+    providerId: string;
+    revoked?: string[];
+    status?: InternalSearchListenerResponseStatus;
+}
+export interface HomeInternalErrorResponse {
+    error: string;
+}
+interface SearchResponse {
+    results: HomeSearchResult[];
+    context?: any;
+}
+export interface InternalDataResponse extends SearchResponse {
+    id: string;
+    providerId: string;
+    revoked?: string[];
+    status?: InternalSearchListenerResponseStatus;
+}
+export interface InternalSearchListenerRequest {
+    close(): void;
+    req: HomeSearchListenerRequest;
+}
+export interface SearchRequest {
+    /** The search query. */
+    query: string;
+    /** Additional custom context that can be used for searching. */
+    context?: Partial<HomeSearchListenerRequest['context']>;
+    /** A list of search provider names to execute the search request against. */
+    targets?: string[];
+}
+/**
+ * Message for dispatching a search request.
+ * This interface is used when sending a dispatch request from a remote OpenFin identity
+ * to the search topic creator.
+ */
+export interface InternalSearchRequest extends SearchRequest {
+    /**
+     * The id of the search request.
+     * On initial search request from remote provider, this ID is generated.
+     * The remote OpenFin identity is required to pass this id on all subsequent requests.
+     */
+    id?: string;
+}
+export interface InternalSearchResponse {
+    /**
+     * The ID of the search request the response pertains to.
+     */
+    id: string;
+    /**
+     * True if the all search providers have responded to the search request.
+     */
+    done?: boolean;
+    /**
+     * The state of the search response generator.
+     */
+    state: SearchProviderResponseGeneratorState;
+    /**
+     * The current list of responses.
+     */
+    value: SearchProviderResponse[];
+}
+export type SearchProviderResponseGenerator = AsyncGenerator<SearchProviderResponse[], SearchProviderResponse[], SearchProviderResponse[]>;
+export interface SearchProviderResponse {
+    /**
+     * The search provider that responded with the search results.
+     */
+    provider: HomeProviderInternal;
+    /**
+     * If the search result succeeds for this provider, results of the search will be set.
+     */
+    results?: HomeSearchResult[];
+    /**
+     * A context with custom data to pass through search
+     */
+    context?: any;
+    /**
+     * If the search failed for this provider, error will be set.
+     */
+    error?: Error;
+}
+export declare enum SearchProviderResponseGeneratorState {
+    /**
+     * The generator is in the process of fetching the initial set of results from search providers.
+     */
+    Fetching = "fetching",
+    /**
+     * The generator has fetched all initial results, and is now waiting for search providers with
+     * open {@link SearchListenerResponse} streams to push new or updated search results.
+     */
+    Fetched = "fetched",
+    /**
+     * All open {@link SearchListenerResponse} streams have closed, completing the request.
+     * In this state, the set of responses returned by `generator.next()` are final.
+     */
+    Complete = "complete"
+}
+export type InternalSearchResponseGeneratorHooks = {
+    setState(state: SearchProviderResponseGeneratorState): void;
+};
+export interface InternalErrorResponse {
+    /**
+     * An error message, denoting that something went wrong.
+     */
+    error: string;
+}
+export interface SearchProviderResponseGeneratorExtended extends SearchProviderResponseGenerator {
+    /**
+     * The id of the search request.
+     */
+    id: string;
+    /**
+     * The state of the search provider response generator.
+     */
+    state: SearchProviderResponseGeneratorState;
+    /**
+     * Notifies all search providers related to this search request
+     * that the search requester is no longer listening for new or updated search results.
+     * @experimental
+     */
+    close: () => void;
+}
+export interface InternalDispatchRequest {
+    result: DispatchedSearchResult;
+    providerId: string;
+    uniqueId: string;
+}
+export declare enum InternalSearchListenerResponseStatus {
+    /**
+     * The initial status of a new search listener response object.
+     *
+     * Denotes that the search provider listener has not taken use of the search listener response object,
+     * as in `response.open()` nor `response.close()` has not been called yet.
+     */
+    Initial = 0,
+    /**
+     * Denotes that the search provider is done sending new or updated search results
+     * for the corresponding request.
+     */
+    Open = 1,
+    /**
+     * Denotes that the search provider is done sending new or updated search results
+     * for the corresponding request.
+     */
+    Close = 2
+}
+export type SearchQueryWithProviderID = {
+    query: string;
+    providerID: string;
+};
+export {};

package/common/src/api/theming.d.ts

@@ -1,11 +1,11 @@
 import type OpenFin from '@openfin/core';
 import type { ThemePaletteSet } from '@openfin/ui-library';
 import { ColorSchemeOptionType } from '../../../client-api-platform/src/shapes';
-export declare type WorkspaceComponentSetSelectedSchemePayload = {
+export type WorkspaceComponentSetSelectedSchemePayload = {
     newScheme: ColorSchemeOptionType;
     identity: OpenFin.Identity;
 };
-export declare type BrowserSetSelectedSchemePayload = string;
+export type BrowserSetSelectedSchemePayload = string;
 export interface ComputedThemes extends Array<ComputedTheme> {
 }
 export interface ComputedTheme {

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

@@ -1,18 +1,18 @@
-export declare type Role = string;
-export declare type AriaOwns = undefined | string;
-export declare type AriaHaspopup = boolean | 'false' | 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
-export declare type AriaAutocomplete = 'none' | 'inline' | 'list' | 'both';
-export declare type AriaControls = undefined | string;
-export declare type AriaActivedescendant = undefined | string;
-export declare type AriaExpanded = boolean | 'false' | 'true';
-export declare type AriaLive = 'none' | 'polite' | 'assertive';
-export declare type A11yBox = {
+export type Role = string;
+export type AriaOwns = undefined | string;
+export type AriaHaspopup = boolean | 'false' | 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
+export type AriaAutocomplete = 'none' | 'inline' | 'list' | 'both';
+export type AriaControls = undefined | string;
+export type AriaActivedescendant = undefined | string;
+export type AriaExpanded = boolean | 'false' | 'true';
+export type AriaLive = 'none' | 'polite' | 'assertive';
+export type A11yBox = {
     'role': Role;
     'aria-expanded': AriaExpanded;
     'aria-owns': AriaOwns;
     'aria-haspopup': AriaHaspopup;
 };
-export declare type A11yInput = {
+export type A11yInput = {
     'aria-controls': AriaControls;
     'aria-autocomplete': AriaAutocomplete;
     'aria-activedescendant': AriaActivedescendant;

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

@@ -12,11 +12,11 @@ export interface ApplicationEvent {
     name?: string;
     uuid?: string;
 }
-export declare type ApplicationListener = (ev: ApplicationEvent) => void;
+export type ApplicationListener = (ev: ApplicationEvent) => void;
 export declare enum LaunchModeType {
     FinProtocol = "fin-protocol"
 }
-export declare type ApplicationInfoExtended = OpenFin.ApplicationInfo & {
+export type ApplicationInfoExtended = OpenFin.ApplicationInfo & {
     initialOptions: OpenFin.ApplicationInfo['initialOptions'] & {
         userAppConfigArgs: any;
     };

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

@@ -5,7 +5,7 @@ export declare enum MenuItemType {
     Submenu = "submenu",
     Checkbox = "checkbox"
 }
-export declare type ShowContextMenuResponse = OpenFin.MenuResult & {
+export type ShowContextMenuResponse = OpenFin.MenuResult & {
     data: string;
 };
 export default function showContextMenu(opts: OpenFin.ShowPopupMenuOptions, win?: OpenFin.Window): Promise<ShowContextMenuResponse>;

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

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
 import { WindowIdentity } from './window';
-export declare type LayoutDOMEventType = 
+export type LayoutDOMEventType = 
 /**
  * Fired when a tab is created in a container. (Emmitted by core)
  */
@@ -10,7 +10,7 @@ export declare type LayoutDOMEventType =
  * Fired when the layout container is ready to be used. (Emitted by us)
  */
  | 'container-resized';
-export declare type LayoutDOMEvent = {
+export type LayoutDOMEvent = {
     type: Extract<LayoutDOMEventType, 'container-resized'>;
 } | {
     type: Extract<LayoutDOMEventType, 'tab-created'>;
@@ -24,7 +24,7 @@ export declare type LayoutDOMEvent = {
     };
     isInitialized: boolean;
 };
-export declare type LayoutDOMEventListener = (ev: LayoutDOMEvent) => void;
+export type LayoutDOMEventListener = (ev: LayoutDOMEvent) => void;
 export declare const getFirstViewFromLayout: (identity?: WindowIdentity) => Promise<{
     name: any;
     uuid: any;

package/common/src/utils/menu-window-provider.d.ts

@@ -1,7 +1,7 @@
 import type OpenFin from '@openfin/core';
 import { ModalResponseContent } from '../../../common/src/utils/menu-config';
 import type { OptionalExceptFor } from '../../../common/src/utils/types';
-declare type MenuEventTypes = {
+type MenuEventTypes = {
     response: [ModalResponseEvent];
     ready: [OpenFin.Identity];
     update: [string, Partial<OpenFin.Bounds>, string];
@@ -17,7 +17,7 @@ export declare const menuEvents: {
     once: <EventKey_3 extends keyof MenuEventTypes>(event: EventKey_3, listener: (...payload: MenuEventTypes[EventKey_3]) => void) => void;
 };
 export declare const emitMenuResponse: (data: ModalResponseEvent['data']) => Promise<void>;
-declare type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'> & {
+type WindowOptionsWithBounds = OptionalExceptFor<OpenFin.WindowOptions, 'name' | 'url'> & {
     top: number;
     left: number;
 };

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

@@ -8,7 +8,6 @@ export declare enum PageRoute {
     HomeSearch = "/home/?deeplink=search",
     HomePagesRename = "/home/pages/rename/",
     Dock = "/dock/",
-    HomeIndicator = "/home/indicator/",
     Browser = "/browser/",
     BrowserPopupMenu = "/browser/popup-menu/",
     Provider = "/provider/",

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

@@ -1,13 +1,13 @@
 import type OpenFin from '@openfin/core';
-export declare type SnapshotDetailsExtended = OpenFin.Snapshot['snapshotDetails'] & {
+export type SnapshotDetailsExtended = OpenFin.Snapshot['snapshotDetails'] & {
     machineId: string;
     machineName?: string;
 };
-export declare type SnapshotExtended = {
+export type SnapshotExtended = {
     snapshotDetails: SnapshotDetailsExtended;
     windows: OpenFin.WindowOptions[];
 };
-export declare type ApplySnapshotOptionsExtended = OpenFin.ApplySnapshotOptions & {
+export type ApplySnapshotOptionsExtended = OpenFin.ApplySnapshotOptions & {
     attachToExistingWindow: boolean;
 };
 /**

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

@@ -1,16 +1,16 @@
-export declare type OptionalExceptFor<T, TRequired extends keyof T = keyof T> = Partial<Pick<T, Exclude<keyof T, TRequired>>> & Required<Pick<T, TRequired>>;
-export declare type StringMap<T> = {
+export type OptionalExceptFor<T, TRequired extends keyof T = keyof T> = Partial<Pick<T, Exclude<keyof T, TRequired>>> & Required<Pick<T, TRequired>>;
+export type StringMap<T> = {
     [key in keyof T]: string;
 };
-export declare type Await<T> = T extends PromiseLike<infer U> ? U : T;
-export declare type ValueOf<T> = T[keyof T];
-export declare type DeepPartial<T> = T extends object ? {
+export type Await<T> = T extends PromiseLike<infer U> ? U : T;
+export type ValueOf<T> = T[keyof T];
+export type DeepPartial<T> = T extends object ? {
     [P in keyof T]?: DeepPartial<T[P]>;
 } : T;
 /**
  A union type that represents a value that can be directly awaited or a promise that will eventually resolve to a value of type T.
  */
-export declare type Awaitable<T> = Awaited<T> | Promise<Awaited<T>>;
+export type Awaitable<T> = Awaited<T> | Promise<Awaited<T>>;
 /**
  * This is a helper type that takes a type T and returns a type that is the same as T, but with all
  * properties that are functions removed.
@@ -30,6 +30,6 @@ export declare type Awaitable<T> = Awaited<T> | Promise<Awaited<T>>;
  * }
  * ```
  */
-export declare type RemoveFunctions<T> = Pick<T, {
+export type RemoveFunctions<T> = Pick<T, {
     [K in keyof T]: T[K] extends Function ? never : K;
 }[keyof T]>;

package/common/src/utils/usage-register.d.ts

@@ -37,7 +37,7 @@ export declare enum AnalyticsSource {
 /**
  * Event for analytics
  */
-export declare type AnalyticsEvent = {
+export type AnalyticsEvent = {
     source: AnalyticsSource;
     type: string;
     action: string;
@@ -52,7 +52,7 @@ export interface AnalyticsEventInternal extends AnalyticsEvent {
      */
     skipValueHashing?: boolean;
 }
-export declare type AnalyticsEventRaise = Omit<AnalyticsEventInternal, 'source'>;
+export type AnalyticsEventRaise = Omit<AnalyticsEventInternal, 'source'>;
 export declare const raiseBrowserAnalytics: (payload: AnalyticsEventRaise) => Promise<void>;
 export declare const raiseBrowserPageAnalytics: (pages: AttachedPage[], action: string) => Promise<void>;
 export declare const raiseHomeAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;