@openfin/core 31.74.21 → 31.74.23
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.
- package/package.json +1 -1
- package/src/OpenFin.d.ts +77 -18
- package/src/api/api-exposer/api-consumer.d.ts +28 -0
- package/src/api/api-exposer/api-consumer.js +28 -0
- package/src/api/api-exposer/api-exposer.d.ts +35 -0
- package/src/api/api-exposer/api-exposer.js +38 -0
- package/src/api/api-exposer/decorators.d.ts +10 -0
- package/src/api/api-exposer/decorators.js +18 -0
- package/src/api/api-exposer/index.d.ts +4 -0
- package/src/api/api-exposer/index.js +20 -0
- package/src/api/api-exposer/strategies/index.d.ts +1 -0
- package/src/api/api-exposer/strategies/index.js +17 -0
- package/src/api/api-exposer/strategies/openfin-channels/channels-consumer.d.ts +14 -0
- package/src/api/api-exposer/strategies/openfin-channels/channels-consumer.js +20 -0
- package/src/api/api-exposer/strategies/openfin-channels/channels-exposer.d.ts +20 -0
- package/src/api/api-exposer/strategies/openfin-channels/channels-exposer.js +23 -0
- package/src/api/api-exposer/strategies/openfin-channels/index.d.ts +2 -0
- package/src/api/api-exposer/strategies/openfin-channels/index.js +18 -0
- package/src/api/application/Factory.js +0 -1
- package/src/api/application/Instance.js +23 -5
- package/src/api/base.d.ts +1 -2
- package/src/api/base.js +1 -2
- package/src/api/events/system.d.ts +6 -3
- package/src/api/fin.js +1 -2
- package/src/api/interappbus/channel/index.d.ts +1 -0
- package/src/api/interappbus/channel/index.js +47 -47
- package/src/api/interappbus/channel/protocols/classic/strategy.js +24 -6
- package/src/api/interappbus/index.js +1 -1
- package/src/api/interop/InteropClient.d.ts +1 -1
- package/src/api/interop/InteropClient.js +1 -1
- package/src/api/interop/SessionContextGroupBroker.d.ts +1 -1
- package/src/api/interop/SessionContextGroupBroker.js +5 -4
- package/src/api/interop/SessionContextGroupClient.js +1 -1
- package/src/api/interop/fdc3/PrivateChannelProvider.d.ts +1 -1
- package/src/api/interop/fdc3/PrivateChannelProvider.js +1 -8
- package/src/api/interop/fdc3/fdc3-1.2.js +34 -1
- package/src/api/interop/fdc3/fdc3-2.0.d.ts +11 -10
- package/src/api/interop/fdc3/fdc3-2.0.js +10 -9
- package/src/api/interop/fdc3/shapes/fdc3v2.d.ts +1 -1
- package/src/api/interop/fdc3/utils.js +24 -4
- package/src/api/platform/Factory.d.ts +2 -1
- package/src/api/platform/Factory.js +1 -4
- package/src/api/platform/Instance.d.ts +6 -5
- package/src/api/platform/Instance.js +1 -0
- package/src/api/platform/layout/Factory.js +15 -4
- package/src/api/platform/layout/Instance.d.ts +6 -0
- package/src/api/platform/layout/Instance.js +29 -1
- package/src/api/platform/layout/controllers/layout-content-cache.d.ts +9 -0
- package/src/api/platform/layout/controllers/layout-content-cache.js +54 -0
- package/src/api/platform/layout/controllers/layout-entities-controller.d.ts +119 -0
- package/src/api/platform/layout/controllers/layout-entities-controller.js +287 -0
- package/src/api/platform/layout/controllers/tab-drag-controller.d.ts +2 -1
- package/src/api/platform/layout/entities/layout-entities.d.ts +235 -0
- package/src/api/platform/layout/entities/layout-entities.js +312 -0
- package/src/api/platform/layout/entities/shapes.d.ts +6 -0
- package/src/api/platform/layout/entities/shapes.js +2 -0
- package/src/api/platform/layout/layout.constants.d.ts +1 -0
- package/src/api/platform/layout/layout.constants.js +4 -0
- package/src/api/platform/layout/shapes.d.ts +3 -0
- package/src/api/platform/layout/utils/layout-traversal.d.ts +4 -0
- package/src/api/platform/layout/utils/layout-traversal.js +65 -0
- package/src/api/platform/provider.d.ts +2 -1
- package/src/api/system/index.d.ts +9 -0
- package/src/api/system/index.js +78 -40
- package/src/api/view/Instance.d.ts +12 -3
- package/src/api/view/Instance.js +39 -4
- package/src/api/webcontents/main.d.ts +2 -22
- package/src/api/webcontents/main.js +2 -1
- package/src/api/window/Instance.d.ts +10 -0
- package/src/api/window/Instance.js +22 -0
- package/src/environment/mockEnvironment.d.ts +27 -0
- package/src/environment/mockEnvironment.js +61 -0
- package/src/mock.js +4 -83
- package/src/shapes/protocol.d.ts +17 -0
- package/src/transport/mockWire.d.ts +11 -0
- package/src/transport/mockWire.js +26 -0
- package/src/transport/transport-errors.d.ts +9 -1
- package/src/transport/transport-errors.js +45 -2
- package/src/transport/transport.d.ts +15 -5
- package/src/transport/transport.js +48 -20
- package/src/util/channel-api-relay.d.ts +13 -0
- package/src/util/channel-api-relay.js +47 -0
- package/src/util/errors.d.ts +1 -0
- package/src/util/errors.js +1 -0
- package/src/util/lazy.d.ts +34 -0
- package/src/util/lazy.js +54 -0
- package/src/util/ref-counter.d.ts +1 -1
- package/src/util/ref-counter.js +3 -2
- package/src/util/reversible-map.d.ts +11 -0
- package/src/util/reversible-map.js +49 -0
- package/src/transport/fin_store.d.ts +0 -4
- package/src/transport/fin_store.js +0 -16
package/package.json
CHANGED
package/src/OpenFin.d.ts
CHANGED
|
@@ -1,21 +1,23 @@
|
|
|
1
|
-
import type { Application } from './api/application';
|
|
1
|
+
import type { Application } from './api/application/index';
|
|
2
2
|
import { AppVersionEvent } from './api/events/system';
|
|
3
3
|
import { TypedEventEmitter } from './api/events/typedEventEmitter';
|
|
4
|
-
import type { ExternalApplication } from './api/external-application';
|
|
4
|
+
import type { ExternalApplication } from './api/external-application/index';
|
|
5
5
|
import { FinApi } from './api/fin';
|
|
6
|
-
import type { _Frame } from './api/frame';
|
|
6
|
+
import type { _Frame } from './api/frame/index';
|
|
7
7
|
import type ChannelClient from './api/interappbus/channel/client';
|
|
8
|
-
import { MessagingProtocols } from './api/interappbus/channel/protocols';
|
|
8
|
+
import { MessagingProtocols } from './api/interappbus/channel/protocols/index';
|
|
9
9
|
import type { ChannelProvider } from './api/interappbus/channel/provider';
|
|
10
|
-
import type { InteropBroker, InteropClient } from './api/interop';
|
|
11
|
-
import type { Platform } from './api/platform';
|
|
12
|
-
import type { Layout } from './api/platform/layout';
|
|
10
|
+
import type { InteropBroker, InteropClient } from './api/interop/index';
|
|
11
|
+
import type { Platform } from './api/platform/index';
|
|
12
|
+
import type { Layout } from './api/platform/layout/index';
|
|
13
13
|
import { PlatformProvider } from './api/platform/provider';
|
|
14
|
-
import { SnapshotSource } from './api/snapshot-source';
|
|
15
|
-
import type { View } from './api/view';
|
|
16
|
-
import { _Window } from './api/window';
|
|
14
|
+
import { SnapshotSource } from './api/snapshot-source/index';
|
|
15
|
+
import type { View } from './api/view/index';
|
|
16
|
+
import { _Window } from './api/window/index';
|
|
17
|
+
import { ColumnOrRow, TabStack } from './api/platform/layout/entities/layout-entities';
|
|
17
18
|
export type Fin<MeType extends EntityType = 'window' | 'view'> = FinApi<MeType>;
|
|
18
|
-
export type { Application, ExternalApplication, _Frame as Frame, ChannelClient, ChannelProvider, Platform, Layout, View, _Window as Window, InteropClient, InteropBroker, SnapshotSource };
|
|
19
|
+
export type { Application, ExternalApplication, _Frame as Frame, ChannelClient, ChannelProvider, Platform, Layout, View, ColumnOrRow, TabStack, _Window as Window, InteropClient, InteropBroker, SnapshotSource };
|
|
20
|
+
export type { LayoutEntityDefinition, LayoutEntityTypes, LayoutPosition } from './api/platform/layout/entities/shapes';
|
|
19
21
|
export type WebContent = View | _Window;
|
|
20
22
|
export type { PlatformProvider };
|
|
21
23
|
export type ApplicationIdentity = {
|
|
@@ -244,7 +246,7 @@ export type DisplayMetadata = {
|
|
|
244
246
|
*/
|
|
245
247
|
readonly glyph?: string;
|
|
246
248
|
};
|
|
247
|
-
export type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad'>;
|
|
249
|
+
export type LegacyWinOptionsInAppOptions = Pick<WindowCreationOptions, 'accelerator' | 'alwaysOnTop' | 'api' | 'aspectRatio' | 'autoplayPolicy' | 'autoShow' | 'backgroundColor' | 'contentNavigation' | 'contextMenu' | 'cornerRounding' | 'customData' | 'customRequestHeaders' | 'defaultCentered' | 'defaultHeight' | 'defaultLeft' | 'defaultTop' | 'defaultWidth' | 'frame' | 'hideOnClose' | 'icon' | 'maxHeight' | 'maximizable' | 'maxWidth' | 'minHeight' | 'minimizable' | 'minWidth' | 'opacity' | 'preloadScripts' | 'resizable' | 'resizeRegion' | 'saveWindowState' | 'ignoreSavedWindowState' | 'shadow' | 'showTaskbarIcon' | 'smallWindow' | 'state' | 'taskbarIconGroup' | 'waitForPageLoad' | '_internalWorkspaceData'>;
|
|
248
250
|
export type Snapshot = {
|
|
249
251
|
windows: WindowCreationOptions[];
|
|
250
252
|
snapshotDetails?: {
|
|
@@ -792,6 +794,11 @@ export type MutableWindowOptions = {
|
|
|
792
794
|
*/
|
|
793
795
|
showTaskbarIcon: boolean;
|
|
794
796
|
interop: InteropConfig;
|
|
797
|
+
/**
|
|
798
|
+
* @internal
|
|
799
|
+
* Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
|
|
800
|
+
*/
|
|
801
|
+
_internalWorkspaceData: any;
|
|
795
802
|
workspacePlatform: WorkspacePlatformOptions;
|
|
796
803
|
};
|
|
797
804
|
export type WorkspacePlatformOptions = {
|
|
@@ -1191,6 +1198,11 @@ export type MutableViewOptions = {
|
|
|
1191
1198
|
*/
|
|
1192
1199
|
preventDragOut: boolean;
|
|
1193
1200
|
interop?: InteropConfig;
|
|
1201
|
+
/**
|
|
1202
|
+
* @internal
|
|
1203
|
+
* Used by Workspace to store custom data. Overwriting or modifying this field may impact the functionality of Workspace
|
|
1204
|
+
*/
|
|
1205
|
+
_internalWorkspaceData: any;
|
|
1194
1206
|
};
|
|
1195
1207
|
/**
|
|
1196
1208
|
* User-facing options for a view.
|
|
@@ -1330,6 +1342,22 @@ export type ApplySnapshotPayload = {
|
|
|
1330
1342
|
*/
|
|
1331
1343
|
options?: ApplySnapshotOptions;
|
|
1332
1344
|
};
|
|
1345
|
+
export type AddViewToStackOptions = {
|
|
1346
|
+
/**
|
|
1347
|
+
* Optional index within the stack to insert the view. Defaults to 0
|
|
1348
|
+
*/
|
|
1349
|
+
index?: number;
|
|
1350
|
+
};
|
|
1351
|
+
export type CreateViewTarget = Identity & {
|
|
1352
|
+
/**
|
|
1353
|
+
* If specified, view creation will not attach to a window and caller must
|
|
1354
|
+
* insert the view into the layout explicitly
|
|
1355
|
+
*/
|
|
1356
|
+
location?: {
|
|
1357
|
+
id: string;
|
|
1358
|
+
index?: number;
|
|
1359
|
+
};
|
|
1360
|
+
};
|
|
1333
1361
|
export type CreateViewPayload = {
|
|
1334
1362
|
/**
|
|
1335
1363
|
* Options for the view to be added.
|
|
@@ -1338,7 +1366,7 @@ export type CreateViewPayload = {
|
|
|
1338
1366
|
/**
|
|
1339
1367
|
* Window the view will be added to. If no target is provided, a new window will be created.
|
|
1340
1368
|
*/
|
|
1341
|
-
target
|
|
1369
|
+
target?: CreateViewTarget;
|
|
1342
1370
|
targetView?: Identity;
|
|
1343
1371
|
};
|
|
1344
1372
|
export type ReplaceViewPayload = {
|
|
@@ -1460,10 +1488,7 @@ export type PlatformWindowOptions = WindowCreationOptions & {
|
|
|
1460
1488
|
*/
|
|
1461
1489
|
stylesheetUrl: string;
|
|
1462
1490
|
};
|
|
1463
|
-
export type PlatformViewCreationOptions = Partial<ViewOptions
|
|
1464
|
-
url: string;
|
|
1465
|
-
target: Identity;
|
|
1466
|
-
};
|
|
1491
|
+
export type PlatformViewCreationOptions = Partial<ViewOptions>;
|
|
1467
1492
|
/**
|
|
1468
1493
|
* Strategy to assign views to process affinity by domain.
|
|
1469
1494
|
*
|
|
@@ -1898,6 +1923,7 @@ export type Margins = {
|
|
|
1898
1923
|
* Options for printing a webpage in OpenFin.
|
|
1899
1924
|
*/
|
|
1900
1925
|
export type PrintOptions = {
|
|
1926
|
+
content?: 'self';
|
|
1901
1927
|
/**
|
|
1902
1928
|
* Disables prompting the user for print settings.
|
|
1903
1929
|
*/
|
|
@@ -1941,7 +1967,7 @@ export type PrintOptions = {
|
|
|
1941
1967
|
/**
|
|
1942
1968
|
* Page range to print.
|
|
1943
1969
|
*/
|
|
1944
|
-
pageRanges?: Record<'from' | 'to', number
|
|
1970
|
+
pageRanges?: Array<Record<'from' | 'to', number>>;
|
|
1945
1971
|
/**
|
|
1946
1972
|
* Duplex mode of the printed webpage.
|
|
1947
1973
|
*/
|
|
@@ -1951,6 +1977,14 @@ export type PrintOptions = {
|
|
|
1951
1977
|
*/
|
|
1952
1978
|
dpi?: Dpi;
|
|
1953
1979
|
};
|
|
1980
|
+
export type ScreenshotPrintOptions = {
|
|
1981
|
+
content: 'screenshot';
|
|
1982
|
+
};
|
|
1983
|
+
export type WindowViewsPrintOptions = {
|
|
1984
|
+
content: 'views';
|
|
1985
|
+
includeSelf?: boolean;
|
|
1986
|
+
};
|
|
1987
|
+
export type WindowPrintOptions = PrintOptions | ScreenshotPrintOptions | WindowViewsPrintOptions;
|
|
1954
1988
|
/**
|
|
1955
1989
|
* A request to write data to the clipboard.
|
|
1956
1990
|
*/
|
|
@@ -2218,6 +2252,7 @@ export type FindInPageResult = {
|
|
|
2218
2252
|
export type FrameInfo = {
|
|
2219
2253
|
name: string;
|
|
2220
2254
|
uuid: string;
|
|
2255
|
+
url: string;
|
|
2221
2256
|
entityType: EntityType;
|
|
2222
2257
|
parent: Identity;
|
|
2223
2258
|
};
|
|
@@ -2894,6 +2929,9 @@ export interface PopupResult<T = any> {
|
|
|
2894
2929
|
data?: T;
|
|
2895
2930
|
lastDispatchResult?: PopupResult;
|
|
2896
2931
|
}
|
|
2932
|
+
export type SystemShutdownHandler = (shutdownEvent: {
|
|
2933
|
+
proceed: () => void;
|
|
2934
|
+
}) => void;
|
|
2897
2935
|
export type AppVersionProgressEvent = {
|
|
2898
2936
|
type: 'app-version-progress';
|
|
2899
2937
|
} & AppVersionProgress;
|
|
@@ -2956,3 +2994,24 @@ export interface InteropActionLoggingOption {
|
|
|
2956
2994
|
export type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
2957
2995
|
export type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
|
2958
2996
|
export type { Me } from './api/me';
|
|
2997
|
+
/**
|
|
2998
|
+
* Configuration for page capture.
|
|
2999
|
+
*/
|
|
3000
|
+
export interface CapturePageOptions {
|
|
3001
|
+
/**
|
|
3002
|
+
* The area of the window to be captured.
|
|
3003
|
+
*/
|
|
3004
|
+
area?: Rectangle;
|
|
3005
|
+
/**
|
|
3006
|
+
* @defaultValue 'png'
|
|
3007
|
+
*
|
|
3008
|
+
* The format of the captured image. Can be 'png', 'jpg', or 'bmp'.
|
|
3009
|
+
*/
|
|
3010
|
+
format?: 'bmp' | 'jpg' | 'png';
|
|
3011
|
+
/**
|
|
3012
|
+
* @defaultValue 100
|
|
3013
|
+
*
|
|
3014
|
+
* Quality of JPEG image. Between 0 - 100.
|
|
3015
|
+
*/
|
|
3016
|
+
quality?: number;
|
|
3017
|
+
}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { ExposedProp } from "./decorators";
|
|
2
|
+
export type ConsumeStrategy<TMetaConsumeOptions, TPropConsumeDefinition> = {
|
|
3
|
+
getExposedFunctions: (options: TMetaConsumeOptions) => Promise<ExposedProp<TPropConsumeDefinition>[]>;
|
|
4
|
+
createFunction: (options: ExposedProp<TPropConsumeDefinition>, meta: TMetaConsumeOptions) => Function;
|
|
5
|
+
};
|
|
6
|
+
type PickOfType<T extends Record<any, any>, TTarget> = {
|
|
7
|
+
[key in keyof T as T[key] extends TTarget | undefined ? key : never]: T[key];
|
|
8
|
+
};
|
|
9
|
+
export type ApiClient<T extends Record<any, any>> = {
|
|
10
|
+
[key in keyof PickOfType<T, Function>]: (...args: Parameters<T[key]>) => ReturnType<T[key]> extends Promise<any> ? ReturnType<T[key]> : Promise<ReturnType<T[key]>>;
|
|
11
|
+
};
|
|
12
|
+
/**
|
|
13
|
+
* Consumer for apis exposed with {@see ApiExposer}.
|
|
14
|
+
*
|
|
15
|
+
* A strategy that matches the strategy used to expose a target API must be provided.
|
|
16
|
+
*/
|
|
17
|
+
export declare class ApiConsumer<TMetaConsumeOptions = any, TPropConsumptionOptions = any> {
|
|
18
|
+
private strategy;
|
|
19
|
+
constructor(strategy: ConsumeStrategy<TMetaConsumeOptions, TPropConsumptionOptions>);
|
|
20
|
+
/**
|
|
21
|
+
* Consumes an api exposed using a given transport strategy, and generates a client
|
|
22
|
+
* for easy, type safe consumption of that client.
|
|
23
|
+
* @param options Strategy specific consumption options.
|
|
24
|
+
* @returns An api client matching the given type.
|
|
25
|
+
*/
|
|
26
|
+
consume: <T extends Record<any, any>>(options: TMetaConsumeOptions) => Promise<ApiClient<T>>;
|
|
27
|
+
}
|
|
28
|
+
export {};
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ApiConsumer = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Consumer for apis exposed with {@see ApiExposer}.
|
|
6
|
+
*
|
|
7
|
+
* A strategy that matches the strategy used to expose a target API must be provided.
|
|
8
|
+
*/
|
|
9
|
+
class ApiConsumer {
|
|
10
|
+
// eslint-disable-next-line
|
|
11
|
+
constructor(strategy) {
|
|
12
|
+
this.strategy = strategy;
|
|
13
|
+
/**
|
|
14
|
+
* Consumes an api exposed using a given transport strategy, and generates a client
|
|
15
|
+
* for easy, type safe consumption of that client.
|
|
16
|
+
* @param options Strategy specific consumption options.
|
|
17
|
+
* @returns An api client matching the given type.
|
|
18
|
+
*/
|
|
19
|
+
this.consume = async (options) => {
|
|
20
|
+
const exposedProperties = await this.strategy.getExposedFunctions(options);
|
|
21
|
+
return exposedProperties.reduce((client, prop) => ({
|
|
22
|
+
...client,
|
|
23
|
+
[prop.key]: this.strategy.createFunction(prop, options)
|
|
24
|
+
}), {});
|
|
25
|
+
};
|
|
26
|
+
}
|
|
27
|
+
}
|
|
28
|
+
exports.ApiConsumer = ApiConsumer;
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
import { ExposedProp } from './decorators';
|
|
2
|
+
export type ConsumptionConfig<T> = {
|
|
3
|
+
key: string;
|
|
4
|
+
options: T;
|
|
5
|
+
};
|
|
6
|
+
export type ExposeStrategy<TInstanceExposeOptions, TPropExposeOptions, TPropConsumeOptions> = {
|
|
7
|
+
/**
|
|
8
|
+
* Exposes the given function on the strategy.
|
|
9
|
+
*/
|
|
10
|
+
exposeFunction: (target: Function, config: {
|
|
11
|
+
key: string;
|
|
12
|
+
options: TPropExposeOptions;
|
|
13
|
+
meta: TInstanceExposeOptions;
|
|
14
|
+
}) => Promise<TPropConsumeOptions>;
|
|
15
|
+
/**
|
|
16
|
+
* Exposes metadata to enable creation of client objects.
|
|
17
|
+
*/
|
|
18
|
+
exposeMeta: (instanceOptions: TInstanceExposeOptions, props: ExposedProp<TPropConsumeOptions>[]) => Promise<void>;
|
|
19
|
+
};
|
|
20
|
+
/**
|
|
21
|
+
* Exposes api services on the transport of choice.
|
|
22
|
+
*/
|
|
23
|
+
export declare class ApiExposer<TInstanceExposeOptions = any, TPropExposeOptions = any, TPropConsumptionOptions = any> {
|
|
24
|
+
private strategy;
|
|
25
|
+
/**
|
|
26
|
+
* @param strategy The expose strategy to use to expose instances.
|
|
27
|
+
*/
|
|
28
|
+
constructor(strategy: ExposeStrategy<TInstanceExposeOptions, TPropExposeOptions, TPropConsumptionOptions>);
|
|
29
|
+
/**
|
|
30
|
+
* Exposes an instance of a given api on
|
|
31
|
+
* @param instance Instance of a class which has been decorated to indicate which functions can be exposed.
|
|
32
|
+
* @param instanceOptions Transport strategy specific options to use when exposing.
|
|
33
|
+
*/
|
|
34
|
+
exposeInstance: (instance: Record<any, any>, instanceOptions: TInstanceExposeOptions) => Promise<void>;
|
|
35
|
+
}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ApiExposer = void 0;
|
|
4
|
+
const decorators_1 = require("./decorators");
|
|
5
|
+
/**
|
|
6
|
+
* Exposes api services on the transport of choice.
|
|
7
|
+
*/
|
|
8
|
+
class ApiExposer {
|
|
9
|
+
/**
|
|
10
|
+
* @param strategy The expose strategy to use to expose instances.
|
|
11
|
+
*/
|
|
12
|
+
// eslint-disable-next-line
|
|
13
|
+
constructor(strategy) {
|
|
14
|
+
this.strategy = strategy;
|
|
15
|
+
/**
|
|
16
|
+
* Exposes an instance of a given api on
|
|
17
|
+
* @param instance Instance of a class which has been decorated to indicate which functions can be exposed.
|
|
18
|
+
* @param instanceOptions Transport strategy specific options to use when exposing.
|
|
19
|
+
*/
|
|
20
|
+
this.exposeInstance = async (instance, instanceOptions) => {
|
|
21
|
+
const exposableProps = (0, decorators_1.getExposedProperties)(instance);
|
|
22
|
+
const exposedProps = await Promise.all(exposableProps.map(async ({ key, options }) => {
|
|
23
|
+
const customConsumptionOptions = await this.strategy.exposeFunction(instance[key].bind(instance), {
|
|
24
|
+
key,
|
|
25
|
+
options,
|
|
26
|
+
meta: instanceOptions
|
|
27
|
+
});
|
|
28
|
+
return {
|
|
29
|
+
key,
|
|
30
|
+
options: customConsumptionOptions
|
|
31
|
+
};
|
|
32
|
+
}));
|
|
33
|
+
await this.strategy.exposeMeta(instanceOptions, exposedProps);
|
|
34
|
+
};
|
|
35
|
+
}
|
|
36
|
+
;
|
|
37
|
+
}
|
|
38
|
+
exports.ApiExposer = ApiExposer;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
export type ExposedProp<T> = {
|
|
2
|
+
key: string;
|
|
3
|
+
options: T;
|
|
4
|
+
};
|
|
5
|
+
export declare const getExposedProperties: <T>(target: Record<any, any>) => ExposedProp<T>[];
|
|
6
|
+
/**
|
|
7
|
+
* Indicates that a class member function can be exposed using {@link ApiExposer}.
|
|
8
|
+
* @param options Options specific to the strategy used in {@link ApiExposer}
|
|
9
|
+
*/
|
|
10
|
+
export declare const expose: <T = undefined>(options?: T) => any;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.expose = exports.getExposedProperties = void 0;
|
|
4
|
+
const exposedProperties = Symbol('exposedProperties');
|
|
5
|
+
const getExposedProperties = (target) => {
|
|
6
|
+
return target[exposedProperties] || target.prototype[exposedProperties] || [];
|
|
7
|
+
};
|
|
8
|
+
exports.getExposedProperties = getExposedProperties;
|
|
9
|
+
/**
|
|
10
|
+
* Indicates that a class member function can be exposed using {@link ApiExposer}.
|
|
11
|
+
* @param options Options specific to the strategy used in {@link ApiExposer}
|
|
12
|
+
*/
|
|
13
|
+
// Returns any as decorator typing is weird.
|
|
14
|
+
const expose = (options) => (target, key, descriptor) => {
|
|
15
|
+
target[exposedProperties] = target[exposedProperties] || [];
|
|
16
|
+
target[exposedProperties].push({ key, descriptor, options });
|
|
17
|
+
};
|
|
18
|
+
exports.expose = expose;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./api-consumer"), exports);
|
|
18
|
+
__exportStar(require("./api-exposer"), exports);
|
|
19
|
+
__exportStar(require("./strategies"), exports);
|
|
20
|
+
__exportStar(require("./decorators"), exports);
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from './openfin-channels';
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./openfin-channels"), exports);
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { ConsumeStrategy } from "../../api-consumer";
|
|
2
|
+
import { ExposedProp } from "../../decorators";
|
|
3
|
+
export type ChannelConsumeOptions = {
|
|
4
|
+
id: string;
|
|
5
|
+
};
|
|
6
|
+
export type ChannelsPropConfig = {
|
|
7
|
+
action: string;
|
|
8
|
+
};
|
|
9
|
+
export declare class ChannelsConsumer implements ConsumeStrategy<ChannelConsumeOptions, ChannelsPropConfig> {
|
|
10
|
+
private channel;
|
|
11
|
+
constructor(channel: any);
|
|
12
|
+
getExposedFunctions: (options: ChannelConsumeOptions) => Promise<ExposedProp<ChannelsPropConfig>[]>;
|
|
13
|
+
createFunction: (prop: ExposedProp<ChannelsPropConfig>) => Function;
|
|
14
|
+
}
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ChannelsConsumer = void 0;
|
|
4
|
+
class ChannelsConsumer {
|
|
5
|
+
// eslint-disable-next-line
|
|
6
|
+
constructor(channel) {
|
|
7
|
+
this.channel = channel;
|
|
8
|
+
this.getExposedFunctions = async (options) => {
|
|
9
|
+
const { id } = options;
|
|
10
|
+
const { props } = await this.channel.dispatch(`api-meta:${id}`);
|
|
11
|
+
return props;
|
|
12
|
+
};
|
|
13
|
+
this.createFunction = (prop) => (...args) => {
|
|
14
|
+
const { action } = prop.options;
|
|
15
|
+
return this.channel.dispatch(action, { args });
|
|
16
|
+
};
|
|
17
|
+
}
|
|
18
|
+
;
|
|
19
|
+
}
|
|
20
|
+
exports.ChannelsConsumer = ChannelsConsumer;
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
import { ExposeStrategy } from '../../api-exposer';
|
|
2
|
+
import { ExposedProp } from '../../decorators';
|
|
3
|
+
import { ChannelsPropConfig } from './channels-consumer';
|
|
4
|
+
type ChannelInstanceExposeOptions = {
|
|
5
|
+
id: string;
|
|
6
|
+
};
|
|
7
|
+
export type ChannelsPropOptions = {
|
|
8
|
+
action?: string;
|
|
9
|
+
} | undefined;
|
|
10
|
+
export declare class ChannelsExposer implements ExposeStrategy<ChannelInstanceExposeOptions, ChannelsPropOptions, ChannelsPropConfig> {
|
|
11
|
+
private channelProviderOrClient;
|
|
12
|
+
constructor(channelProviderOrClient: any);
|
|
13
|
+
exposeFunction: (target: Function, config: {
|
|
14
|
+
key: string;
|
|
15
|
+
options: ChannelsPropOptions;
|
|
16
|
+
meta: ChannelInstanceExposeOptions;
|
|
17
|
+
}) => Promise<ChannelsPropConfig>;
|
|
18
|
+
exposeMeta: ({ id }: ChannelInstanceExposeOptions, props: ExposedProp<ChannelsPropOptions>[]) => Promise<void>;
|
|
19
|
+
}
|
|
20
|
+
export {};
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.ChannelsExposer = void 0;
|
|
4
|
+
class ChannelsExposer {
|
|
5
|
+
// eslint-disable-next-line
|
|
6
|
+
constructor(channelProviderOrClient) {
|
|
7
|
+
this.channelProviderOrClient = channelProviderOrClient;
|
|
8
|
+
this.exposeFunction = async (target, config) => {
|
|
9
|
+
const { key, options, meta } = config;
|
|
10
|
+
const { id } = meta;
|
|
11
|
+
const action = `${id}.${(options === null || options === void 0 ? void 0 : options.action) || key}`;
|
|
12
|
+
await this.channelProviderOrClient.register(action, async ({ args }) => {
|
|
13
|
+
return target(...args);
|
|
14
|
+
});
|
|
15
|
+
return { action };
|
|
16
|
+
};
|
|
17
|
+
this.exposeMeta = async ({ id }, props) => {
|
|
18
|
+
const action = `api-meta:${id}`;
|
|
19
|
+
await this.channelProviderOrClient.register(action, () => ({ props }));
|
|
20
|
+
};
|
|
21
|
+
}
|
|
22
|
+
}
|
|
23
|
+
exports.ChannelsExposer = ChannelsExposer;
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
__exportStar(require("./channels-consumer"), exports);
|
|
18
|
+
__exportStar(require("./channels-exposer"), exports);
|
|
@@ -203,7 +203,6 @@ class ApplicationModule extends base_1.Base {
|
|
|
203
203
|
// we do not want to expose this error, just continue if this analytics-only call fails
|
|
204
204
|
});
|
|
205
205
|
const app = await this._createFromManifest(manifestUrl);
|
|
206
|
-
// eslint-disable-next-line @typescript-eslint/ban-ts-comment
|
|
207
206
|
// @ts-expect-error using private method without warning.
|
|
208
207
|
await app._run(opts); // eslint-disable-line no-underscore-dangle
|
|
209
208
|
return app;
|
|
@@ -141,11 +141,29 @@ class Application extends base_1.EmitterBase {
|
|
|
141
141
|
* @tutorial Application.quit
|
|
142
142
|
*/
|
|
143
143
|
async quit(force = false) {
|
|
144
|
-
|
|
145
|
-
|
|
146
|
-
|
|
147
|
-
|
|
148
|
-
|
|
144
|
+
try {
|
|
145
|
+
await this._close(force);
|
|
146
|
+
await this.wire.sendAction('destroy-application', { force, ...this.identity });
|
|
147
|
+
}
|
|
148
|
+
catch (error) {
|
|
149
|
+
const acceptableErrors = [
|
|
150
|
+
'Remote connection has closed',
|
|
151
|
+
'Could not locate the requested application'
|
|
152
|
+
];
|
|
153
|
+
if (!acceptableErrors.some(msg => error.message.includes(msg))) {
|
|
154
|
+
throw error;
|
|
155
|
+
}
|
|
156
|
+
}
|
|
157
|
+
}
|
|
158
|
+
async _close(force = false) {
|
|
159
|
+
try {
|
|
160
|
+
await this.wire.sendAction('close-application', { force, ...this.identity });
|
|
161
|
+
}
|
|
162
|
+
catch (error) {
|
|
163
|
+
if (!error.message.includes('Remote connection has closed')) {
|
|
164
|
+
throw error;
|
|
165
|
+
}
|
|
166
|
+
}
|
|
149
167
|
}
|
|
150
168
|
close(force = false) {
|
|
151
169
|
console.warn('Deprecation Warning: Application.close is deprecated Please use Application.quit');
|
package/src/api/base.d.ts
CHANGED
|
@@ -2,14 +2,13 @@
|
|
|
2
2
|
import { EventEmitter } from 'events';
|
|
3
3
|
import { Transport } from '../transport/transport';
|
|
4
4
|
import type * as OpenFin from '../OpenFin';
|
|
5
|
-
import Fin from './fin';
|
|
6
5
|
import { BaseEvent, EventHandler } from './events/base';
|
|
7
6
|
type ApplicationIdentity = OpenFin.ApplicationIdentity;
|
|
8
7
|
type Identity = OpenFin.Identity;
|
|
9
8
|
export declare class Base {
|
|
10
9
|
wire: Transport;
|
|
11
10
|
constructor(wire: Transport);
|
|
12
|
-
protected get fin(): Fin
|
|
11
|
+
protected get fin(): OpenFin.Fin<OpenFin.EntityType>;
|
|
13
12
|
get me(): Identity;
|
|
14
13
|
protected isNodeEnvironment: () => boolean;
|
|
15
14
|
protected isOpenFinEnvironment: () => boolean;
|
package/src/api/base.js
CHANGED
|
@@ -14,7 +14,6 @@ var _EmitterBase_emitterAccessor;
|
|
|
14
14
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
15
15
|
exports.Reply = exports.EmitterBase = exports.Base = void 0;
|
|
16
16
|
const promises_1 = require("../util/promises");
|
|
17
|
-
const fin_store_1 = require("../transport/fin_store");
|
|
18
17
|
class Base {
|
|
19
18
|
constructor(wire) {
|
|
20
19
|
this.isNodeEnvironment = () => {
|
|
@@ -29,7 +28,7 @@ class Base {
|
|
|
29
28
|
this.wire = wire;
|
|
30
29
|
}
|
|
31
30
|
get fin() {
|
|
32
|
-
return
|
|
31
|
+
return this.wire.getFin();
|
|
33
32
|
}
|
|
34
33
|
get me() {
|
|
35
34
|
return this.wire.me;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type * as OpenFin from '../../OpenFin';
|
|
2
2
|
import { PropagatedApplicationEvent } from './application';
|
|
3
|
-
import { BaseEvent } from './base';
|
|
3
|
+
import { BaseEvent, IdentityEvent } from './base';
|
|
4
4
|
import { PropagatedViewEvent } from './view';
|
|
5
5
|
import { PropagatedWindowEvent } from './window';
|
|
6
6
|
import { AppVersionCompleteEvent, AppVersionErrorEvent, AppVersionProgressEvent, AppVersionRuntimeStatusEvent } from '../../OpenFin';
|
|
@@ -38,13 +38,16 @@ export type EventWithId<Event extends AppVersionEvent> = Event extends infer E e
|
|
|
38
38
|
appVersionId: string;
|
|
39
39
|
} : never;
|
|
40
40
|
export type AppVersionEventWithId = EventWithId<AppVersionEvent>;
|
|
41
|
-
export type ApplicationCreatedEvent =
|
|
41
|
+
export type ApplicationCreatedEvent = IdentityEvent & {
|
|
42
42
|
type: 'application-created';
|
|
43
43
|
};
|
|
44
44
|
export type DesktopIconClickedEvent = BaseEvent & {
|
|
45
45
|
type: 'desktop-icon-clicked';
|
|
46
46
|
};
|
|
47
|
+
export type SystemShutdownEvent = BaseEvent & {
|
|
48
|
+
type: 'system-shutdown';
|
|
49
|
+
};
|
|
47
50
|
export type SystemEvent = {
|
|
48
51
|
topic: 'system';
|
|
49
|
-
} & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId);
|
|
52
|
+
} & (ExcludeRequested<PropagatedWindowEvent> | PropagatedViewEvent | PropagatedApplicationEvent | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleEvent | MonitorEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent);
|
|
50
53
|
export type SystemEventType = SystemEvent['type'];
|
package/src/api/fin.js
CHANGED
|
@@ -13,13 +13,11 @@ const index_8 = require("./global-hotkey/index");
|
|
|
13
13
|
const index_9 = require("./view/index");
|
|
14
14
|
const index_10 = require("./platform/index");
|
|
15
15
|
const me_1 = require("./me");
|
|
16
|
-
const fin_store_1 = require("../transport/fin_store");
|
|
17
16
|
const interop_1 = require("./interop");
|
|
18
17
|
const snapshot_source_1 = require("./snapshot-source");
|
|
19
18
|
class Fin extends events_1.EventEmitter {
|
|
20
19
|
constructor(wire) {
|
|
21
20
|
super();
|
|
22
|
-
(0, fin_store_1.registerFin)(wire, this);
|
|
23
21
|
this.wire = wire;
|
|
24
22
|
this.System = new index_1.default(wire);
|
|
25
23
|
this.Window = new index_2.default(wire);
|
|
@@ -33,6 +31,7 @@ class Fin extends events_1.EventEmitter {
|
|
|
33
31
|
this.View = new index_9.default(wire);
|
|
34
32
|
this.Interop = new interop_1.default(wire);
|
|
35
33
|
this.SnapshotSource = new snapshot_source_1.default(wire);
|
|
34
|
+
wire.registerFin(this);
|
|
36
35
|
this.me = (0, me_1.getMe)(wire);
|
|
37
36
|
// Handle disconnect events
|
|
38
37
|
wire.on('disconnected', () => {
|
|
@@ -15,6 +15,7 @@ export interface ChannelMessage extends Message<any> {
|
|
|
15
15
|
export declare class Channel extends EmitterBase<ChannelEvent> {
|
|
16
16
|
#private;
|
|
17
17
|
constructor(wire: Transport);
|
|
18
|
+
private channelExists;
|
|
18
19
|
getAllChannels(): Promise<ProviderIdentity[]>;
|
|
19
20
|
onChannelConnect(listener: (...args: any[]) => void): Promise<void>;
|
|
20
21
|
onChannelDisconnect(listener: (...args: any[]) => void): Promise<void>;
|