@openfin/core 29.73.3 → 29.73.5
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/OpenFin.d.ts +79 -1
- package/package.json +1 -1
- package/src/OpenFin.d.ts +1452 -0
- package/src/OpenFin.js +4 -0
- package/src/api/events/system.d.ts +18 -3
- package/src/api/events/typedEventEmitter.d.ts +13 -0
- package/src/api/events/typedEventEmitter.js +2 -0
- package/src/api/interop/Factory.js +1 -1
- package/src/api/interop/InteropBroker.d.ts +36 -5
- package/src/api/interop/InteropBroker.js +56 -8
- package/src/api/interop/fdc3/PrivateChannelClient.d.ts +8 -7
- package/src/api/interop/fdc3/fdc3-1.2.d.ts +14 -13
- package/src/api/interop/fdc3/fdc3-2.0.d.ts +24 -21
- package/src/api/interop/fdc3/fdc3-2.0.js +11 -18
- package/src/api/interop/fdc3/fdc3.d.ts +13 -0
- package/src/api/interop/fdc3/shapes/fdc3v1.d.ts +53 -0
- package/src/api/interop/fdc3/shapes/fdc3v1.js +4 -0
- package/src/api/interop/fdc3/shapes/fdc3v2.d.ts +74 -0
- package/src/api/interop/fdc3/shapes/fdc3v2.js +2 -0
- package/src/api/interop/fdc3/utils.d.ts +7 -5
- package/src/api/interop/fdc3/utils.js +2 -2
- package/src/api/interop/utils.d.ts +1 -0
- package/src/api/interop/utils.js +9 -1
- package/src/api/platform/Instance.d.ts +12 -0
- package/src/api/platform/Instance.js +15 -0
- package/src/api/platform/layout/utils/bounds-observer.d.ts +1 -1
- package/src/api/platform/layout/utils/bounds-observer.js +2 -2
- package/src/api/system/index.d.ts +1 -470
- package/src/api/system/index.js +52 -472
- package/src/api/view/Instance.d.ts +8 -0
- package/src/api/view/Instance.js +16 -0
- package/src/fdc3.d.ts +3 -0
- package/src/shapes/protocol.d.ts +3 -1
package/OpenFin.d.ts
CHANGED
|
@@ -105,6 +105,7 @@ declare namespace OpenFin {
|
|
|
105
105
|
|
|
106
106
|
type InteropBrokerOptions = {
|
|
107
107
|
contextGroups?: ContextGroupInfo;
|
|
108
|
+
logging?: InteropLoggingOptions;
|
|
108
109
|
};
|
|
109
110
|
|
|
110
111
|
export type ContextGroupInfo = {
|
|
@@ -529,6 +530,13 @@ declare namespace OpenFin {
|
|
|
529
530
|
accelerator?: Partial<OpenFin.Accelerator>;
|
|
530
531
|
};
|
|
531
532
|
|
|
533
|
+
export type ViewState = ViewCreationOptions & {
|
|
534
|
+
backgroundThrottling: boolean;
|
|
535
|
+
componentName: 'view';
|
|
536
|
+
initialUrl: string;
|
|
537
|
+
minWidth?: number;
|
|
538
|
+
};
|
|
539
|
+
|
|
532
540
|
export type Certificate = {
|
|
533
541
|
data: string;
|
|
534
542
|
fingerprint: string;
|
|
@@ -615,9 +623,28 @@ declare namespace OpenFin {
|
|
|
615
623
|
setFileDownloadLocation: boolean;
|
|
616
624
|
};
|
|
617
625
|
|
|
626
|
+
export type LaunchExternalProcessRule = {
|
|
627
|
+
behavior: 'allow' | 'block';
|
|
628
|
+
match: string[]; // could be url match or path match
|
|
629
|
+
};
|
|
630
|
+
|
|
618
631
|
export type SystemPermissions = {
|
|
619
632
|
getAllExternalWindows: boolean;
|
|
620
|
-
launchExternalProcess:
|
|
633
|
+
launchExternalProcess:
|
|
634
|
+
| boolean
|
|
635
|
+
| {
|
|
636
|
+
assets: {
|
|
637
|
+
enabled: boolean;
|
|
638
|
+
srcRules?: LaunchExternalProcessRule[];
|
|
639
|
+
};
|
|
640
|
+
downloads: {
|
|
641
|
+
enabled: boolean;
|
|
642
|
+
};
|
|
643
|
+
executables: {
|
|
644
|
+
enabled: boolean;
|
|
645
|
+
pathRules?: LaunchExternalProcessRule[];
|
|
646
|
+
};
|
|
647
|
+
};
|
|
621
648
|
readRegistryValue:
|
|
622
649
|
| boolean
|
|
623
650
|
| {
|
|
@@ -728,6 +755,7 @@ declare namespace OpenFin {
|
|
|
728
755
|
forwardErrorReports?: boolean;
|
|
729
756
|
enableErrorReporting?: boolean;
|
|
730
757
|
};
|
|
758
|
+
interopBrokerConfiguration: InteropBrokerOptions;
|
|
731
759
|
};
|
|
732
760
|
|
|
733
761
|
export type LayoutContent = (LayoutItemConfig | LayoutRow | LayoutColumn | LayoutComponent)[];
|
|
@@ -815,6 +843,13 @@ declare namespace OpenFin {
|
|
|
815
843
|
*/
|
|
816
844
|
getSnapshot(payload: undefined, identity: OpenFin.Identity): Promise<OpenFin.Snapshot>;
|
|
817
845
|
|
|
846
|
+
/**
|
|
847
|
+
* Gets the current state of a single view and returns an object with the options needed to restore that view as part of a snapshot.
|
|
848
|
+
* @param { Identity } payload Identity of the view.
|
|
849
|
+
* @return { Promise<ViewState> }
|
|
850
|
+
*/
|
|
851
|
+
getViewSnapshot(payload: { viewIdentity: Identity }): Promise<ViewState>;
|
|
852
|
+
|
|
818
853
|
/**
|
|
819
854
|
* Called when a snapshot is being applied and some windows in that snapshot would be fully or partially off-screen.
|
|
820
855
|
* Returns an array of windows with modified positions, such that any off-screen windows are positioned in the top left
|
|
@@ -1145,10 +1180,44 @@ declare namespace OpenFin {
|
|
|
1145
1180
|
'working-dir': string;
|
|
1146
1181
|
};
|
|
1147
1182
|
|
|
1183
|
+
export type AppVersionProgress = {
|
|
1184
|
+
manifest: string | null; // A manifest in the fallbackManifest list
|
|
1185
|
+
srcManifest: string; // To keep track of the original manifest url
|
|
1186
|
+
};
|
|
1187
|
+
|
|
1188
|
+
export type AppVersionError = {
|
|
1189
|
+
error: string;
|
|
1190
|
+
srcManifest: string; // To keep track of the original manifest url
|
|
1191
|
+
};
|
|
1192
|
+
|
|
1193
|
+
export type AppVersionRuntimeInfo = {
|
|
1194
|
+
version: string | null; // will be null if a manifest url is not reachable
|
|
1195
|
+
exists: boolean | null;
|
|
1196
|
+
writeAccess: boolean | null;
|
|
1197
|
+
reachable: boolean | null;
|
|
1198
|
+
healthCheck: boolean | null;
|
|
1199
|
+
error: string | null;
|
|
1200
|
+
};
|
|
1201
|
+
|
|
1202
|
+
export type AppVersionProgressEvent = { type: 'app-version-progress' } & AppVersionProgress;
|
|
1203
|
+
export type AppVersionErrorEvent = { type: 'app-version-error' } & AppVersionError;
|
|
1204
|
+
export type AppVersionCompleteEvent = { type: 'app-version-complete' } & AppVersionProgress;
|
|
1205
|
+
export type AppVersionRuntimeStatusEvent = { type: 'runtime-status' } & AppVersionRuntimeInfo;
|
|
1206
|
+
|
|
1207
|
+
export type AppVersionEvents =
|
|
1208
|
+
| AppVersionProgressEvent
|
|
1209
|
+
| AppVersionRuntimeStatusEvent
|
|
1210
|
+
| AppVersionCompleteEvent
|
|
1211
|
+
| AppVersionErrorEvent;
|
|
1212
|
+
|
|
1213
|
+
export type AppVersionEventNames = AppVersionEvents['type'];
|
|
1214
|
+
export type LaunchEmitter = import('./src/api/events/typedEventEmitter').TypedEventEmitter<AppVersionEvents>;
|
|
1215
|
+
|
|
1148
1216
|
export type RvmLaunchOptions = {
|
|
1149
1217
|
noUi?: boolean;
|
|
1150
1218
|
userAppConfigArgs?: object;
|
|
1151
1219
|
timeToLive?: number;
|
|
1220
|
+
subscribe?: (launch: LaunchEmitter) => void;
|
|
1152
1221
|
};
|
|
1153
1222
|
|
|
1154
1223
|
export type ShortCutConfig = {
|
|
@@ -1254,6 +1323,7 @@ declare namespace OpenFin {
|
|
|
1254
1323
|
lifetime?: string;
|
|
1255
1324
|
certificate?: CertificationInfo;
|
|
1256
1325
|
uuid?: string;
|
|
1326
|
+
fileUuid?: string;
|
|
1257
1327
|
initialWindowState?: string;
|
|
1258
1328
|
cwd?: string;
|
|
1259
1329
|
};
|
|
@@ -1749,4 +1819,12 @@ declare namespace OpenFin {
|
|
|
1749
1819
|
export type InteropClientOnDisconnectionListener = (
|
|
1750
1820
|
InteropBrokerDisconnectionEvent: InteropBrokerDisconnectionEvent
|
|
1751
1821
|
) => any;
|
|
1822
|
+
|
|
1823
|
+
export interface InteropActionLoggingOption {
|
|
1824
|
+
enabled: boolean;
|
|
1825
|
+
}
|
|
1826
|
+
|
|
1827
|
+
export type InteropLoggingActions = 'beforeAction' | 'afterAction';
|
|
1828
|
+
|
|
1829
|
+
export type InteropLoggingOptions = Record<InteropLoggingActions, InteropActionLoggingOption>;
|
|
1752
1830
|
}
|