@openfin/workspace 13.1.4 → 14.0.11

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (65) hide show
  1. package/README.md +14 -14
  2. package/client-api/src/home.test.d.ts +1 -1
  3. package/client-api/src/integrations/microsoft.shapes.d.ts +9 -9
  4. package/client-api/src/internal/home/handlers/data.d.ts +3 -0
  5. package/client-api/src/internal/home/handlers/data.test.d.ts +1 -0
  6. package/client-api/src/internal/home/handlers/disconnect.d.ts +1 -0
  7. package/client-api/src/internal/home/handlers/disconnect.test.d.ts +1 -0
  8. package/client-api/src/internal/home/handlers/index.d.ts +6 -0
  9. package/client-api/src/internal/home/handlers/index.test.d.ts +1 -0
  10. package/client-api/src/internal/home/handlers/result-dispatch.d.ts +3 -0
  11. package/client-api/src/internal/home/handlers/result-dispatch.test.d.ts +1 -0
  12. package/client-api/src/internal/home/handlers/search-close.d.ts +5 -0
  13. package/client-api/src/internal/home/handlers/search-close.test.d.ts +1 -0
  14. package/client-api/src/internal/home/index.d.ts +4 -0
  15. package/client-api/src/internal/home/requests.d.ts +5 -0
  16. package/client-api/src/internal/providers.d.ts +63 -0
  17. package/client-api/src/internal/providers.test.d.ts +1 -0
  18. package/client-api/src/internal/storefront/handlers.d.ts +9 -0
  19. package/client-api/src/internal/storefront/index.d.ts +4 -0
  20. package/client-api/src/{internal.d.ts → internal/try-dispatch.d.ts} +1 -1
  21. package/client-api/src/shapes/common.d.ts +1 -1
  22. package/client-api/src/shapes/dock.d.ts +3 -3
  23. package/client-api/src/shapes/home.d.ts +18 -18
  24. package/client-api/src/shapes/notifications.d.ts +2 -2
  25. package/client-api/src/shapes/store.d.ts +6 -6
  26. package/client-api/src/shapes/templates.d.ts +11 -11
  27. package/client-api-platform/src/init/utils.d.ts +2 -2
  28. package/client-api-platform/src/shapes.d.ts +15 -15
  29. package/common/src/api/action.d.ts +1 -1
  30. package/common/src/api/home.d.ts +25 -0
  31. package/common/src/api/pages/shapes.d.ts +6 -6
  32. package/common/src/api/protocol/browser.d.ts +1 -1
  33. package/common/src/api/protocol/shapes/search.d.ts +96 -0
  34. package/common/src/api/protocol/shapes/workspace.d.ts +13 -13
  35. package/common/src/api/protocol/workspace-platform.d.ts +1 -1
  36. package/common/src/api/protocol/workspace.d.ts +2 -0
  37. package/common/src/api/provider.d.ts +24 -9
  38. package/common/src/api/search/aggregate-search-results.d.ts +10 -0
  39. package/common/src/api/search/common.d.ts +13 -0
  40. package/common/src/api/shapes/home.d.ts +186 -0
  41. package/common/src/api/theming.d.ts +2 -2
  42. package/common/src/utils/a11y/search.a11y.d.ts +10 -10
  43. package/common/src/utils/application.d.ts +2 -2
  44. package/common/src/utils/context-menu.d.ts +1 -1
  45. package/common/src/utils/layout.d.ts +3 -3
  46. package/common/src/utils/menu-window-provider.d.ts +2 -2
  47. package/common/src/utils/route.d.ts +0 -1
  48. package/common/src/utils/snapshot.d.ts +3 -3
  49. package/common/src/utils/types.d.ts +7 -7
  50. package/common/src/utils/usage-register.d.ts +2 -2
  51. package/home.js +128 -23
  52. package/home.js.map +1 -1
  53. package/index.js +127 -22
  54. package/index.js.map +1 -1
  55. package/notifications.js +124 -19
  56. package/notifications.js.map +1 -1
  57. package/package.json +3 -3
  58. package/search-api/src/fin/shapes.d.ts +2 -2
  59. package/search-api/src/provider/remote/deregistration.d.ts +2 -1
  60. package/search-api/src/provider/remote/info.d.ts +1 -1
  61. package/search-api/src/provider/remote/registration.d.ts +1 -1
  62. package/search-api/src/shapes.d.ts +11 -21
  63. package/store.js +130 -25
  64. package/store.js.map +1 -1
  65. package/common/src/api/search.d.ts +0 -18
package/README.md CHANGED
@@ -4,20 +4,20 @@ The Workspace Client APIs enable custom integrations with OpenFin Workspace.
4
4
 
5
5
  ## Prerequisites
6
6
 
7
- - [Node.js](https://nodejs.org/en/) v16.0.0 or higher
8
- - [npm](https://www.npmjs.com/)
7
+ - [Node.js](https://nodejs.org/en/) v16.0.0 or higher
8
+ - [npm](https://www.npmjs.com/)
9
9
 
10
10
  ## Install
11
11
 
12
12
  With npm:
13
13
 
14
- ```
14
+ ```sh
15
15
  $ npm i @openfin/workspace@latest
16
16
  ```
17
17
 
18
18
  With yarn:
19
19
 
20
- ```
20
+ ```sh
21
21
  $ yarn global add @openfin/workspace
22
22
  ```
23
23
 
@@ -27,8 +27,8 @@ Prior to using Workspace, a Workspace Platform must be initialized.
27
27
 
28
28
  ### Home API
29
29
 
30
- - [Overview](https://developers.openfin.co/of-docs/docs/cli-providers)
31
- - [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/home.html)
30
+ - [Overview](https://developers.openfin.co/of-docs/docs/cli-providers)
31
+ - [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/home.html)
32
32
 
33
33
  ```ts
34
34
  import Home, CLIProvider from '@openfin/workspace';
@@ -64,8 +64,8 @@ searchButton.addEventListener('click', () => {
64
64
 
65
65
  ### Storefront API
66
66
 
67
- - [Overview](https://developers.openfin.co/of-docs/docs/provide-storefront-content)
68
- - [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/store.html)
67
+ - [Overview](https://developers.openfin.co/of-docs/docs/provide-storefront-content)
68
+ - [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/store.html)
69
69
 
70
70
  ```ts
71
71
  import { Storefront, StorefrontProvider } from "@openfin/workspace";
@@ -97,8 +97,8 @@ await Storefront.show();
97
97
 
98
98
  ### Dock API
99
99
 
100
- - [Overview](https://developers.openfin.co/of-docs/docs/dock-overview)
101
- - [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/dock.html)
100
+ - [Overview](https://developers.openfin.co/of-docs/docs/dock-overview)
101
+ - [API Reference](https://developer.openfin.co/workspace/docs/api/latest/modules/dock.html)
102
102
 
103
103
  ```ts
104
104
  const provider: DockProvider = {
@@ -154,7 +154,7 @@ await Dock.show();
154
154
 
155
155
  ## For more information
156
156
 
157
- - [Developer guide](https://developers.openfin.co/of-docs/docs/overview-of-workspace).
158
- - [API reference](https://developer.openfin.co/workspace/docs/api/latest/index.html).
159
- - See the [workspace-starter](https://github.com/built-on-openfin/workspace-starter) project for example code.
160
- - See the [versions page](https://developer.openfin.co/versions/#/?product=Workspace) for a list of all available versions.
157
+ - [Developer guide](https://developers.openfin.co/of-docs/docs/overview-of-workspace).
158
+ - [API reference](https://developer.openfin.co/workspace/docs/api/latest/index.html).
159
+ - See the [workspace-starter](https://github.com/built-on-openfin/workspace-starter) project for example code.
160
+ - See the [versions page](https://developer.openfin.co/versions/#/?product=Workspace) for a list of all available versions.
@@ -1 +1 @@
1
- export {};
1
+ import '@common/test/fin-mocks';
@@ -148,17 +148,17 @@ export interface Microsoft365IntegrationConfig extends WorkflowIntegrationConfig
148
148
  /**
149
149
  * @internal
150
150
  */
151
- declare type MicrosoftGraphAPIHttpMethod = 'GET' | 'HEAD' | 'PATCH' | 'POST' | 'PUT' | 'DELETE';
151
+ type MicrosoftGraphAPIHttpMethod = 'GET' | 'HEAD' | 'PATCH' | 'POST' | 'PUT' | 'DELETE';
152
152
  /**
153
153
  * https://docs.microsoft.com/en-us/graph/json-batching#request-format
154
154
  * @internal
155
155
  */
156
- export declare type GraphBatchRequest = GraphBatchRequestItem[];
156
+ export type GraphBatchRequest = GraphBatchRequestItem[];
157
157
  /**
158
158
  * https://docs.microsoft.com/en-us/graph/json-batching#request-format
159
159
  * @internal
160
160
  */
161
- export declare type GraphBatchRequestItem = {
161
+ export type GraphBatchRequestItem = {
162
162
  body?: any;
163
163
  headers?: {
164
164
  [id: string]: string;
@@ -170,13 +170,13 @@ export declare type GraphBatchRequestItem = {
170
170
  /**
171
171
  * @internal
172
172
  */
173
- export declare type GraphBatchRequestResponse = {
173
+ export type GraphBatchRequestResponse = {
174
174
  responses: GraphBatchRequestResponseItem[];
175
175
  };
176
176
  /**
177
177
  * @internal
178
178
  */
179
- export declare type GraphBatchRequestResponseItem = {
179
+ export type GraphBatchRequestResponseItem = {
180
180
  body: any;
181
181
  headers: HeadersInit;
182
182
  id: string;
@@ -185,15 +185,15 @@ export declare type GraphBatchRequestResponseItem = {
185
185
  /**
186
186
  * @internal
187
187
  */
188
- export declare type GraphListResponse<T = unknown> = {
188
+ export type GraphListResponse<T = unknown> = {
189
189
  value: T[];
190
190
  };
191
191
  /** @internal */
192
- export declare type Microsoft365DocumentType = 'Email' | 'Chat Message' | 'Event' | 'Document' | 'Contact' | 'User' | 'List';
192
+ export type Microsoft365DocumentType = 'Email' | 'Chat Message' | 'Event' | 'Document' | 'Contact' | 'User' | 'List';
193
193
  /** @internal */
194
- declare type Microsoft365TypeFilterType = 'Document' | 'Contact' | 'Chat Message' | 'Message' | 'Event' | 'List';
194
+ type Microsoft365TypeFilterType = 'Document' | 'Contact' | 'Chat Message' | 'Message' | 'Event' | 'List';
195
195
  /** @internal */
196
- export declare type Microsoft365HomeSearchFilterTypeFilter = {
196
+ export type Microsoft365HomeSearchFilterTypeFilter = {
197
197
  value: Microsoft365TypeFilterType;
198
198
  isSelected: boolean;
199
199
  };
@@ -0,0 +1,3 @@
1
+ import { HomeClientApiDataRequest, HomeInternalDataResponse, HomeInternalErrorResponse, InternalDataResponse } from '../../../../../common/src/api/shapes/home';
2
+ export declare function pushDataResponse(res: InternalDataResponse): Promise<void>;
3
+ export declare function handleDataRequest(req: HomeClientApiDataRequest): Promise<HomeInternalDataResponse | HomeInternalErrorResponse>;
@@ -0,0 +1 @@
1
+ export declare function handleChannelDisconnection(): Promise<void>;
@@ -0,0 +1,6 @@
1
+ import { SearchAPIClientChannelClient } from '../../../../../common/src/api/protocol/shapes/search';
2
+ type HomeWorkspaceAPIClientChannelClient = SearchAPIClientChannelClient & {
3
+ homeChannelActionsRegistered?: boolean;
4
+ };
5
+ export declare function registerHomeChannelClientActions(channel: HomeWorkspaceAPIClientChannelClient): void;
6
+ export {};
@@ -0,0 +1,3 @@
1
+ import type OpenFin from '@openfin/core';
2
+ import type { HomeClientApiDispatchRequest } from '../../../../../common/src/api/shapes/home';
3
+ export declare function handleResultDispatch(req: HomeClientApiDispatchRequest, identity: OpenFin.Identity): Promise<void>;
@@ -0,0 +1,5 @@
1
+ import type { HomeClientApiSearchCloseRequest } from '../../../../../common/src/api/shapes/home';
2
+ /**
3
+ * Listens for search requests that have been closed.
4
+ */
5
+ export declare function handleSearchRequestClose(req: HomeClientApiSearchCloseRequest): void;
@@ -0,0 +1,4 @@
1
+ import { ProvidersMap } from '../../../../client-api/src/internal/providers';
2
+ import { CLIProvider, HomeProvider, RegisterMetaInfoInternal } from '../..';
3
+ export declare const HomeProviders: ProvidersMap<HomeProvider | CLIProvider>;
4
+ export declare const registerHomeProviderInternal: (provider: HomeProvider | CLIProvider) => Promise<RegisterMetaInfoInternal>;
@@ -0,0 +1,5 @@
1
+ import type { InternalSearchListenerRequest } from '../../../../common/src/api/shapes/home';
2
+ /**
3
+ * Map of search requests.
4
+ */
5
+ export declare const searchRequests: Map<string, InternalSearchListenerRequest>;
@@ -0,0 +1,63 @@
1
+ import { ProviderType } from '../../../common/src/api/provider';
2
+ export declare class ProviderNotRegisteredError extends Error {
3
+ constructor(providerType: ProviderType, id?: string);
4
+ }
5
+ export declare class ProviderAlreadyRegisteredError extends Error {
6
+ constructor(providerType: ProviderType, id?: string);
7
+ }
8
+ export declare class FailedToGetProviderError extends Error {
9
+ constructor(providerType: ProviderType, id?: string);
10
+ }
11
+ /**
12
+ * Utility class for managing providers.
13
+ */
14
+ export declare class ProvidersMap<T extends {
15
+ id: string;
16
+ }> {
17
+ private readonly providersMap;
18
+ private readonly providerType;
19
+ constructor(providerType: ProviderType);
20
+ /**
21
+ * Asserts that a provider is not already registered.
22
+ * @param provider The provider to check.
23
+ * @throws ProviderAlreadyRegisteredError if the provider already exists.
24
+ */
25
+ assertNotAlreadyRegistered(id: string): void;
26
+ /**
27
+ * Asserts that a provider is registered.
28
+ * @param provider The provider to check.
29
+ * @throws ProviderAlreadyRegisteredError if the provider already exists.
30
+ */
31
+ assertRegistered(id: string): void;
32
+ /**
33
+ * Gets a provider by id.
34
+ * @param id The id of the provider to get.
35
+ * @returns The provider if it exists, otherwise undefined.
36
+ */
37
+ getProvider(id: string): T | undefined;
38
+ /**
39
+ * Checks if a provider exists.
40
+ * @param id The id of the provider to check.
41
+ * @returns True if the provider exists, otherwise false.
42
+ */
43
+ hasProvider(id: string): boolean;
44
+ /**
45
+ * Sets a provider.
46
+ * @param provider The provider to set.
47
+ */
48
+ setProvider(provider: T): void;
49
+ /**
50
+ * Deletes a provider.
51
+ * @param id The id of the provider to delete.
52
+ */
53
+ deleteProvider(id: string): void;
54
+ /**
55
+ * Gets a provider by id or throws an error if it does not exist.
56
+ * @param id The id of the provider to get.
57
+ * @returns The provider if it exists.
58
+ * @throws An error if the provider does not exist.
59
+ * @see {@link ProviderNotRegisteredError}
60
+ */
61
+ getProviderOrFail(id: string): T;
62
+ clearProviders(): void;
63
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,9 @@
1
+ import { WorkspaceAPIClientChannelClient } from '../../../../common/src/api/protocol/workspace';
2
+ type StorefrontWorkspaceAPIClientChannelClient = WorkspaceAPIClientChannelClient & {
3
+ storefrontChannelActionsRegistered?: boolean;
4
+ };
5
+ /**
6
+ * Registers a channel action for each function in the Storefront provider.
7
+ */
8
+ export declare const registerStorefrontChannelClientActions: (channel: StorefrontWorkspaceAPIClientChannelClient) => void;
9
+ export {};
@@ -0,0 +1,4 @@
1
+ import { ProvidersMap } from '../../../../client-api/src/internal/providers';
2
+ import { RegisterMetaInfoInternal, StorefrontProvider } from '../../../../client-api/src/shapes';
3
+ export declare const StorefrontProviders: ProvidersMap<StorefrontProvider>;
4
+ export declare const registerStorefrontProviderInternal: (provider: StorefrontProvider) => Promise<RegisterMetaInfoInternal>;
@@ -1,4 +1,4 @@
1
- import { WorkspaceChannelAction } from '../../common/src/api/protocol/shapes/workspace';
1
+ import { WorkspaceChannelAction } from '../../../common/src/api/protocol/shapes/workspace';
2
2
  export interface ChannelDispatch {
3
3
  action: WorkspaceChannelAction;
4
4
  payload?: any;
@@ -11,4 +11,4 @@ export interface RegistrationMetaInfo {
11
11
  clientAPIVersion: string;
12
12
  workspaceVersion: string;
13
13
  }
14
- export declare type RegisterMetaInfoInternal = Pick<RegistrationMetaInfo, 'workspaceVersion'>;
14
+ export type RegisterMetaInfoInternal = Pick<RegistrationMetaInfo, 'workspaceVersion'>;
@@ -101,7 +101,7 @@ export interface DockDropdownConfig extends CustomDropdownConfig {
101
101
  /**
102
102
  * Dock button types
103
103
  */
104
- export declare type DockButton = {
104
+ export type DockButton = {
105
105
  /** Optional button identifier, if not provided will be automatically generated by the provider */ id?: string;
106
106
  } & (DockButtonConfig | DockDropdownConfig);
107
107
  /**
@@ -109,7 +109,7 @@ export declare type DockButton = {
109
109
  *
110
110
  * Used in {@link WorkspaceButtonsConfig}.
111
111
  */
112
- export declare type WorkspaceButton = 'switchWorkspace' | 'home' | 'notifications' | 'store';
112
+ export type WorkspaceButton = 'switchWorkspace' | 'home' | 'notifications' | 'store';
113
113
  /**
114
114
  * Controls the visibility as well as the order of buttons for workspace components on the Dock.
115
115
  *
@@ -132,7 +132,7 @@ export declare type WorkspaceButton = 'switchWorkspace' | 'home' | 'notification
132
132
  * const workspaceButtonsConfig: WorkspaceButtonsConfig = [];
133
133
  * ```
134
134
  */
135
- export declare type WorkspaceButtonsConfig = WorkspaceButton[];
135
+ export type WorkspaceButtonsConfig = WorkspaceButton[];
136
136
  /**
137
137
  * Configuration for the Dock provider.
138
138
  */
@@ -8,7 +8,7 @@ import type { Workspace } from '../../../common/src/api/workspaces';
8
8
  import type { Action, DispatchedSearchResult, SearchListenerRequest, SearchListenerResponse, SearchProvider, SearchResult } from '../../../search-api/src/index';
9
9
  import { RegistrationMetaInfo } from './common';
10
10
  import { CustomTemplate, ListPairs } from './templates';
11
- export declare type CLISearchListenerRequest = SearchListenerRequest;
11
+ export type CLISearchListenerRequest = SearchListenerRequest;
12
12
  /**
13
13
  * Representation of a search request from a specific invocation of a {@link HomeProvider | HomeProvider's} `onUserInput` listener function.
14
14
  */
@@ -39,16 +39,20 @@ export interface HomeSearchListenerRequest extends CLISearchListenerRequest {
39
39
  isSearchEngines: boolean;
40
40
  /**
41
41
  * any user-selected filters will be populated here
42
- * e.g [{
43
- * title: 'Currency Pairs',
44
- * type: FilterOptionType.MultiSelect,
45
- * options: [{ value: 'GBPUSD', isSelected: true}]
42
+ *
43
+ * @example
44
+ * ```ts
45
+ * [{
46
+ * title: 'Currency Pairs',
47
+ * type: FilterOptionType.MultiSelect,
48
+ * options: [{ value: 'GBPUSD', isSelected: true}]
46
49
  * }]
50
+ * ```
47
51
  */
48
52
  selectedFilters?: CLIFilter[];
49
53
  };
50
54
  }
51
- export declare type CLISearchListenerResponse = SearchListenerResponse;
55
+ export type CLISearchListenerResponse = SearchListenerResponse;
52
56
  /**
53
57
  * Representation of a search response from a specific invocation of a {@link HomeProvider | HomeProvider's} `onUserInput` listener function.
54
58
  * Can optionally be used to push search results to the Home UI.
@@ -68,7 +72,7 @@ export declare type CLISearchListenerResponse = SearchListenerResponse;
68
72
  * }
69
73
  * ```
70
74
  */
71
- export declare type HomeSearchListenerResponse = Omit<CLISearchListenerResponse, 'respond'> & {
75
+ export type HomeSearchListenerResponse = Omit<CLISearchListenerResponse, 'respond'> & {
72
76
  respond(results: HomeSearchResult[]): void;
73
77
  };
74
78
  /**
@@ -95,11 +99,11 @@ export interface CLISuggestion extends CLIBuiltInAction<CLIAction.Suggestion> {
95
99
  /**
96
100
  * Union type that includes Home's built in search result actions.
97
101
  */
98
- export declare type HomeAction = CLISuggestion | Action;
102
+ export type HomeAction = CLISuggestion | Action;
99
103
  /**
100
104
  * A search result that can be rendered by a Workspace component.
101
105
  */
102
- export declare type CLISearchResult<A extends Action> = SearchResult<A>;
106
+ export type CLISearchResult<A extends Action> = SearchResult<A>;
103
107
  /**
104
108
  * A list of template types that determine how a search result is rendered.
105
109
  */
@@ -173,7 +177,7 @@ export interface ContactInfo {
173
177
  */
174
178
  buttons?: ContactInfoButtons[];
175
179
  }
176
- export declare type ButtonIcon =
180
+ export type ButtonIcon =
177
181
  /**
178
182
  * The icon used for the button.
179
183
  */
@@ -187,7 +191,7 @@ string | {
187
191
  */
188
192
  dark: string;
189
193
  };
190
- export declare type ContactInfoButtons = {
194
+ export type ContactInfoButtons = {
191
195
  type: 'button';
192
196
  /**
193
197
  * The icon to display on the button.
@@ -271,7 +275,7 @@ export interface CLISearchResultError<A extends Action = Action> extends CLISear
271
275
  /**
272
276
  * A search result that can be rendered by Home UI.
273
277
  */
274
- export declare type HomeSearchResult = CLISearchResultContact<HomeAction> | CLISearchResultSimpleText<HomeAction> | CLISearchResultList<HomeAction> | CLISearchResultPlain<HomeAction> | CLISearchResultCustom<HomeAction> | CLISearchResultLoading<HomeAction> | CLISearchResultError<HomeAction>;
278
+ export type HomeSearchResult = CLISearchResultContact<HomeAction> | CLISearchResultSimpleText<HomeAction> | CLISearchResultList<HomeAction> | CLISearchResultPlain<HomeAction> | CLISearchResultCustom<HomeAction> | CLISearchResultLoading<HomeAction> | CLISearchResultError<HomeAction>;
275
279
  export declare enum CLIFilterOptionType {
276
280
  /**
277
281
  * Display a multi-select drop down for the options
@@ -325,7 +329,7 @@ export interface HomeSearchResponse extends CLISearchResponse {
325
329
  /**
326
330
  * A rendered search result that has been actioned by a user.
327
331
  */
328
- export declare type CLIDispatchedSearchResult = DispatchedSearchResult;
332
+ export type CLIDispatchedSearchResult = DispatchedSearchResult;
329
333
  /**
330
334
  * A CLI provider responds to search requests from Workspace components.
331
335
  * Upon receiving a search request, a CLI provider can return search results that can be rendered and interacted with
@@ -419,11 +423,7 @@ export interface HomeProvider extends CLIProvider {
419
423
  /**
420
424
  * A rendered Home search result that has been actioned by a user.
421
425
  */
422
- export declare type HomeDispatchedSearchResult = HomeSearchResult & DispatchedSearchResult;
423
- export interface SearchQueryWithProviderID {
424
- providerID: string;
425
- query: string;
426
- }
426
+ export type HomeDispatchedSearchResult = HomeSearchResult & DispatchedSearchResult;
427
427
  /**
428
428
  * Response from home registration which includes metadata and a function to inject search string into home search
429
429
  */
@@ -17,11 +17,11 @@ import type { NotificationPlatform as NotificationsPlatformInternal } from 'open
17
17
  * await register(platform);
18
18
  * ```
19
19
  */
20
- export declare type NotificationsPlatform = Omit<NotificationsPlatformInternal, 'theme'>;
20
+ export type NotificationsPlatform = Omit<NotificationsPlatformInternal, 'theme'>;
21
21
  /**
22
22
  * Registration meta info returned by {@link register}
23
23
  */
24
- export declare type NotificationsRegistration = {
24
+ export type NotificationsRegistration = {
25
25
  clientAPIVersion: string;
26
26
  notificationsVersion: string;
27
27
  };
@@ -151,14 +151,14 @@ export interface StorefrontNavigationSection {
151
151
  * Represents the existing StorefrontDetailedNavigationItem and existing App interfaces
152
152
  * Used by StorefrontLandingPage to represent items in the bottom, middle and top rows.
153
153
  */
154
- export declare type StorefrontLandingPageItem = StorefrontDetailedNavigationItem | App;
155
- export declare type StorefrontLandingPageTopRow = [
154
+ export type StorefrontLandingPageItem = StorefrontDetailedNavigationItem | App;
155
+ export type StorefrontLandingPageTopRow = [
156
156
  StorefrontLandingPageItem?,
157
157
  StorefrontLandingPageItem?,
158
158
  StorefrontLandingPageItem?,
159
159
  StorefrontLandingPageItem?
160
160
  ];
161
- export declare type StorefrontLandingPageMiddleRow = [
161
+ export type StorefrontLandingPageMiddleRow = [
162
162
  StorefrontLandingPageItem?,
163
163
  StorefrontLandingPageItem?,
164
164
  StorefrontLandingPageItem?,
@@ -166,7 +166,7 @@ export declare type StorefrontLandingPageMiddleRow = [
166
166
  StorefrontLandingPageItem?,
167
167
  StorefrontLandingPageItem?
168
168
  ];
169
- export declare type StorefrontLandingPageBottomRow = [
169
+ export type StorefrontLandingPageBottomRow = [
170
170
  StorefrontLandingPageItem?,
171
171
  StorefrontLandingPageItem?,
172
172
  StorefrontLandingPageItem?
@@ -305,11 +305,11 @@ export interface StorefrontNavigationItemLandingPage extends StorefrontNavigatio
305
305
  /**
306
306
  * Render an item in the navigation bar of Storefront.
307
307
  */
308
- export declare type StorefrontNavigationItem = StorefrontNavigationItemAppGrid | StorefrontNavigationItemLandingPage;
308
+ export type StorefrontNavigationItem = StorefrontNavigationItemAppGrid | StorefrontNavigationItemLandingPage;
309
309
  /**
310
310
  * Render an item in the navigation bar of Storefront with a description and image.
311
311
  */
312
- export declare type StorefrontDetailedNavigationItem = StorefrontNavigationItem & StorefrontNavigationItemDetails;
312
+ export type StorefrontDetailedNavigationItem = StorefrontNavigationItem & StorefrontNavigationItemDetails;
313
313
  /**
314
314
  * Describes a Storefront provided by a platform.
315
315
  * A platform must provide an object that satisfies this interface in order to register with the Storefront.
@@ -3,15 +3,15 @@
3
3
  *
4
4
  * @module Templates
5
5
  */
6
- export declare type ListPairs = [string, string][];
7
- export declare type CustomTemplateData = Record<string, string | ListPairs>;
8
- export declare type ContainerFragmentTypes = PlainContainerTemplateFragment | ButtonTemplateFragment;
9
- export declare type PresentationFragmentTypes = TextTemplateFragment | ImageTemplateFragment | ListTemplateFragment;
10
- export declare type InteractiveFragmentTypes = ButtonTemplateFragment | TextTemplateFragment | ImageTemplateFragment;
6
+ export type ListPairs = [string, string][];
7
+ export type CustomTemplateData = Record<string, string | ListPairs>;
8
+ export type ContainerFragmentTypes = PlainContainerTemplateFragment | ButtonTemplateFragment;
9
+ export type PresentationFragmentTypes = TextTemplateFragment | ImageTemplateFragment | ListTemplateFragment;
10
+ export type InteractiveFragmentTypes = ButtonTemplateFragment | TextTemplateFragment | ImageTemplateFragment;
11
11
  /**
12
12
  * The options to build your custom template composition layout.
13
13
  */
14
- export declare type TemplateFragment = PlainContainerTemplateFragment | ButtonTemplateFragment | TextTemplateFragment | ListTemplateFragment | ImageTemplateFragment;
14
+ export type TemplateFragment = PlainContainerTemplateFragment | ButtonTemplateFragment | TextTemplateFragment | ListTemplateFragment | ImageTemplateFragment;
15
15
  export declare const ContainerTemplateFragmentNames: {
16
16
  readonly Container: "Container";
17
17
  readonly Button: "Button";
@@ -108,21 +108,21 @@ export declare enum ButtonStyle {
108
108
  Secondary = "secondary",
109
109
  TextOnly = "textOnly"
110
110
  }
111
- export declare type PlainContainerTemplateFragment = ContainerTemplateFragment<'Container'>;
112
- export declare type ButtonTemplateFragment = ContainerTemplateFragment<'Button'> & FragmentAction & {
111
+ export type PlainContainerTemplateFragment = ContainerTemplateFragment<'Container'>;
112
+ export type ButtonTemplateFragment = ContainerTemplateFragment<'Button'> & FragmentAction & {
113
113
  /**
114
114
  * Style of the button emitted by this fragment.
115
115
  */
116
116
  buttonStyle?: ButtonStyle;
117
117
  };
118
- export declare type TextTemplateFragment = PresentationTemplateFragment<'Text'> & FragmentAction;
119
- export declare type ImageTemplateFragment = PresentationTemplateFragment<'Image'> & FragmentAction & {
118
+ export type TextTemplateFragment = PresentationTemplateFragment<'Text'> & FragmentAction;
119
+ export type ImageTemplateFragment = PresentationTemplateFragment<'Image'> & FragmentAction & {
120
120
  /**
121
121
  * Alternative (accessibility) text for the image.
122
122
  */
123
123
  alternativeText: string;
124
124
  };
125
- export declare type ListTemplateFragment = PresentationTemplateFragment<'List'>;
125
+ export type ListTemplateFragment = PresentationTemplateFragment<'List'>;
126
126
  export interface CustomTemplate {
127
127
  /**
128
128
  * Root of the template composition tree. See {@link ContainerTemplateFragment} for nesting.
@@ -22,12 +22,12 @@ export declare const filterSnapshotWindows: (win: OpenFin.WindowOptions) => bool
22
22
  * @returns unprocessed or processed options object
23
23
  */
24
24
  export declare const fitToMonitor: (options: OpenFin.PlatformWindowCreationOptions) => Promise<OpenFin.PlatformWindowCreationOptions>;
25
- declare type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
25
+ type LegacyWindowOptions = Omit<OpenFin.PlatformWindowCreationOptions, 'workspacePlatform'> & {
26
26
  pages?: Page[];
27
27
  workstacks?: Page[];
28
28
  };
29
29
  export declare const initWorkspacePlatformOptions: (options: LegacyWindowOptions | OpenFin.PlatformWindowCreationOptions) => OpenFin.PlatformWindowCreationOptions;
30
- export declare type WindowType = 'browser' | 'platform' | 'classic' | 'mixed';
30
+ export type WindowType = 'browser' | 'platform' | 'classic' | 'mixed';
31
31
  /**
32
32
  * checkSnapshotWindowTypes
33
33
  * Determines what type of windows are contained within a snapshot.