@openfin/fdc3-api 45.100.72 → 45.100.74
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/out/fdc3-api-alpha.d.ts +111 -0
- package/out/fdc3-api-beta.d.ts +111 -0
- package/out/fdc3-api-public.d.ts +111 -0
- package/out/fdc3-api.d.ts +111 -0
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -3101,6 +3101,53 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3101
3101
|
childOptions: OpenFin.WindowOptions;
|
|
3102
3102
|
};
|
|
3103
3103
|
|
|
3104
|
+
/**
|
|
3105
|
+
* End of Interop Client Events
|
|
3106
|
+
*/
|
|
3107
|
+
/**
|
|
3108
|
+
* Client-side handle for the chrome-browser feature.
|
|
3109
|
+
*
|
|
3110
|
+
* For Chrome extension integration to be active on a window, that window must be
|
|
3111
|
+
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3112
|
+
* `init()` step.
|
|
3113
|
+
*/
|
|
3114
|
+
declare interface ChromeBrowser {
|
|
3115
|
+
/**
|
|
3116
|
+
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3117
|
+
*/
|
|
3118
|
+
readonly Actions: ChromeBrowserActions;
|
|
3119
|
+
}
|
|
3120
|
+
|
|
3121
|
+
/**
|
|
3122
|
+
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
3123
|
+
*
|
|
3124
|
+
* @interface
|
|
3125
|
+
*/
|
|
3126
|
+
declare interface ChromeBrowserActions {
|
|
3127
|
+
/**
|
|
3128
|
+
* Returns the current list of extension actions with the minimal render state
|
|
3129
|
+
* required to build a toolbar UI.
|
|
3130
|
+
*/
|
|
3131
|
+
getExtensionActions(): Promise<ExtensionActionListItem[]>;
|
|
3132
|
+
/**
|
|
3133
|
+
* Executes the specified extension action.
|
|
3134
|
+
*
|
|
3135
|
+
* @remarks
|
|
3136
|
+
* This may trigger an extension popup to be shown by the Runtime if the extension
|
|
3137
|
+
* has a popup configured for the currently active tab.
|
|
3138
|
+
*/
|
|
3139
|
+
invokeExtensionAction(options: ExtensionActionInvokeOptions): Promise<void>;
|
|
3140
|
+
/**
|
|
3141
|
+
* Hides the active extension popup, if any.
|
|
3142
|
+
*/
|
|
3143
|
+
hideActiveExtensionPopup(): Promise<void>;
|
|
3144
|
+
/**
|
|
3145
|
+
* Reactive value reflecting the current extension action list.
|
|
3146
|
+
* Compatible with React's `useSyncExternalStore`.
|
|
3147
|
+
*/
|
|
3148
|
+
readonly state: Readable<ExtensionActionListItem[]>;
|
|
3149
|
+
}
|
|
3150
|
+
|
|
3104
3151
|
/**
|
|
3105
3152
|
* Control behavior for Chromium policies
|
|
3106
3153
|
*
|
|
@@ -5428,6 +5475,33 @@ declare type ExitCode = {
|
|
|
5428
5475
|
exitCode: number;
|
|
5429
5476
|
};
|
|
5430
5477
|
|
|
5478
|
+
/**
|
|
5479
|
+
* Options for invoking an extension action.
|
|
5480
|
+
*
|
|
5481
|
+
* @interface
|
|
5482
|
+
*/
|
|
5483
|
+
declare type ExtensionActionInvokeOptions = {
|
|
5484
|
+
extensionId: ExtensionId;
|
|
5485
|
+
/** Anchor in window client coordinates (from getBoundingClientRect). */
|
|
5486
|
+
anchor: Anchor;
|
|
5487
|
+
};
|
|
5488
|
+
|
|
5489
|
+
/**
|
|
5490
|
+
* Minimal UI model required to render a list of extension actions.
|
|
5491
|
+
*
|
|
5492
|
+
* @interface
|
|
5493
|
+
*/
|
|
5494
|
+
declare type ExtensionActionListItem = {
|
|
5495
|
+
/** Stable ID for the extension that owns this action. */
|
|
5496
|
+
extensionId: ExtensionId;
|
|
5497
|
+
/** Whether to show the action button for the current context (active tab). */
|
|
5498
|
+
isVisible: boolean;
|
|
5499
|
+
/** Accessible label / title for the action button. */
|
|
5500
|
+
title: string;
|
|
5501
|
+
/** Renderer-safe icon (data URL). */
|
|
5502
|
+
iconDataUrl: string;
|
|
5503
|
+
};
|
|
5504
|
+
|
|
5431
5505
|
declare type ExtensionEvent = SecurityRealmEvent & {
|
|
5432
5506
|
/**
|
|
5433
5507
|
* Runtime extension whose status has been (possibly) modified
|
|
@@ -5435,6 +5509,13 @@ declare type ExtensionEvent = SecurityRealmEvent & {
|
|
|
5435
5509
|
extension: string;
|
|
5436
5510
|
};
|
|
5437
5511
|
|
|
5512
|
+
/**
|
|
5513
|
+
* Unique identifier of a Chromium extension.
|
|
5514
|
+
*
|
|
5515
|
+
* @interface
|
|
5516
|
+
*/
|
|
5517
|
+
declare type ExtensionId = string;
|
|
5518
|
+
|
|
5438
5519
|
/**
|
|
5439
5520
|
* @interface
|
|
5440
5521
|
*/
|
|
@@ -6224,6 +6305,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6224
6305
|
readonly Interop: InteropModule;
|
|
6225
6306
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6226
6307
|
readonly NotificationManager: NotificationManagerModule;
|
|
6308
|
+
readonly ChromeBrowser: OpenFin.ChromeBrowser;
|
|
6227
6309
|
/**
|
|
6228
6310
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6229
6311
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -10609,6 +10691,7 @@ declare namespace OpenFin {
|
|
|
10609
10691
|
SnapshotSource,
|
|
10610
10692
|
SnapshotSourceModule,
|
|
10611
10693
|
System,
|
|
10694
|
+
Readable,
|
|
10612
10695
|
LayoutEntityDefinition,
|
|
10613
10696
|
LayoutEntityTypes,
|
|
10614
10697
|
LayoutPosition,
|
|
@@ -10641,6 +10724,10 @@ declare namespace OpenFin {
|
|
|
10641
10724
|
AnchorLocation,
|
|
10642
10725
|
Anchor,
|
|
10643
10726
|
DownloadBubbleOptions,
|
|
10727
|
+
ExtensionId,
|
|
10728
|
+
ExtensionActionListItem,
|
|
10729
|
+
ExtensionActionInvokeOptions,
|
|
10730
|
+
ChromeBrowserActions,
|
|
10644
10731
|
DisplayMetadata,
|
|
10645
10732
|
LegacyWinOptionsInAppOptions,
|
|
10646
10733
|
Snapshot,
|
|
@@ -11006,6 +11093,7 @@ declare namespace OpenFin {
|
|
|
11006
11093
|
InteropClientEvent,
|
|
11007
11094
|
ClientChangedContextGroup,
|
|
11008
11095
|
InteropClientEvents,
|
|
11096
|
+
ChromeBrowser,
|
|
11009
11097
|
ApplicationEvents,
|
|
11010
11098
|
BaseEvents,
|
|
11011
11099
|
ExternalApplicationEvents,
|
|
@@ -14178,6 +14266,14 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14178
14266
|
};
|
|
14179
14267
|
response: void;
|
|
14180
14268
|
};
|
|
14269
|
+
'chrome-browser-get-extension-actions': ApiCall<{}, {
|
|
14270
|
+
actions: OpenFin.ExtensionActionListItem[];
|
|
14271
|
+
}>;
|
|
14272
|
+
'chrome-browser-invoke-extension-action': ApiCall<{
|
|
14273
|
+
extensionId: string;
|
|
14274
|
+
anchor: OpenFin.Anchor;
|
|
14275
|
+
}, void>;
|
|
14276
|
+
'chrome-browser-hide-active-extension-popup': ApiCall<{}, void>;
|
|
14181
14277
|
};
|
|
14182
14278
|
|
|
14183
14279
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
@@ -14274,6 +14370,21 @@ declare type QueryPermissionResult = {
|
|
|
14274
14370
|
rawValue?: unknown;
|
|
14275
14371
|
};
|
|
14276
14372
|
|
|
14373
|
+
/**
|
|
14374
|
+
* A readonly implementation of the observable pattern.
|
|
14375
|
+
* Frameworks and vanilla consumers use this to read state and subscribe to changes.
|
|
14376
|
+
*/
|
|
14377
|
+
declare interface Readable<T> {
|
|
14378
|
+
/** Synchronously returns the current value. */
|
|
14379
|
+
get(): T;
|
|
14380
|
+
/**
|
|
14381
|
+
* Subscribes to changes.
|
|
14382
|
+
* @param listener A callback that is invoked when the value changes.
|
|
14383
|
+
* @returns An unsubscribe function to clean up the listener.
|
|
14384
|
+
*/
|
|
14385
|
+
subscribe(listener: () => void): () => void;
|
|
14386
|
+
}
|
|
14387
|
+
|
|
14277
14388
|
/**
|
|
14278
14389
|
* @interface
|
|
14279
14390
|
*/
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -3101,6 +3101,53 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3101
3101
|
childOptions: OpenFin.WindowOptions;
|
|
3102
3102
|
};
|
|
3103
3103
|
|
|
3104
|
+
/**
|
|
3105
|
+
* End of Interop Client Events
|
|
3106
|
+
*/
|
|
3107
|
+
/**
|
|
3108
|
+
* Client-side handle for the chrome-browser feature.
|
|
3109
|
+
*
|
|
3110
|
+
* For Chrome extension integration to be active on a window, that window must be
|
|
3111
|
+
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3112
|
+
* `init()` step.
|
|
3113
|
+
*/
|
|
3114
|
+
declare interface ChromeBrowser {
|
|
3115
|
+
/**
|
|
3116
|
+
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3117
|
+
*/
|
|
3118
|
+
readonly Actions: ChromeBrowserActions;
|
|
3119
|
+
}
|
|
3120
|
+
|
|
3121
|
+
/**
|
|
3122
|
+
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
3123
|
+
*
|
|
3124
|
+
* @interface
|
|
3125
|
+
*/
|
|
3126
|
+
declare interface ChromeBrowserActions {
|
|
3127
|
+
/**
|
|
3128
|
+
* Returns the current list of extension actions with the minimal render state
|
|
3129
|
+
* required to build a toolbar UI.
|
|
3130
|
+
*/
|
|
3131
|
+
getExtensionActions(): Promise<ExtensionActionListItem[]>;
|
|
3132
|
+
/**
|
|
3133
|
+
* Executes the specified extension action.
|
|
3134
|
+
*
|
|
3135
|
+
* @remarks
|
|
3136
|
+
* This may trigger an extension popup to be shown by the Runtime if the extension
|
|
3137
|
+
* has a popup configured for the currently active tab.
|
|
3138
|
+
*/
|
|
3139
|
+
invokeExtensionAction(options: ExtensionActionInvokeOptions): Promise<void>;
|
|
3140
|
+
/**
|
|
3141
|
+
* Hides the active extension popup, if any.
|
|
3142
|
+
*/
|
|
3143
|
+
hideActiveExtensionPopup(): Promise<void>;
|
|
3144
|
+
/**
|
|
3145
|
+
* Reactive value reflecting the current extension action list.
|
|
3146
|
+
* Compatible with React's `useSyncExternalStore`.
|
|
3147
|
+
*/
|
|
3148
|
+
readonly state: Readable<ExtensionActionListItem[]>;
|
|
3149
|
+
}
|
|
3150
|
+
|
|
3104
3151
|
/**
|
|
3105
3152
|
* Control behavior for Chromium policies
|
|
3106
3153
|
*
|
|
@@ -5428,6 +5475,33 @@ declare type ExitCode = {
|
|
|
5428
5475
|
exitCode: number;
|
|
5429
5476
|
};
|
|
5430
5477
|
|
|
5478
|
+
/**
|
|
5479
|
+
* Options for invoking an extension action.
|
|
5480
|
+
*
|
|
5481
|
+
* @interface
|
|
5482
|
+
*/
|
|
5483
|
+
declare type ExtensionActionInvokeOptions = {
|
|
5484
|
+
extensionId: ExtensionId;
|
|
5485
|
+
/** Anchor in window client coordinates (from getBoundingClientRect). */
|
|
5486
|
+
anchor: Anchor;
|
|
5487
|
+
};
|
|
5488
|
+
|
|
5489
|
+
/**
|
|
5490
|
+
* Minimal UI model required to render a list of extension actions.
|
|
5491
|
+
*
|
|
5492
|
+
* @interface
|
|
5493
|
+
*/
|
|
5494
|
+
declare type ExtensionActionListItem = {
|
|
5495
|
+
/** Stable ID for the extension that owns this action. */
|
|
5496
|
+
extensionId: ExtensionId;
|
|
5497
|
+
/** Whether to show the action button for the current context (active tab). */
|
|
5498
|
+
isVisible: boolean;
|
|
5499
|
+
/** Accessible label / title for the action button. */
|
|
5500
|
+
title: string;
|
|
5501
|
+
/** Renderer-safe icon (data URL). */
|
|
5502
|
+
iconDataUrl: string;
|
|
5503
|
+
};
|
|
5504
|
+
|
|
5431
5505
|
declare type ExtensionEvent = SecurityRealmEvent & {
|
|
5432
5506
|
/**
|
|
5433
5507
|
* Runtime extension whose status has been (possibly) modified
|
|
@@ -5435,6 +5509,13 @@ declare type ExtensionEvent = SecurityRealmEvent & {
|
|
|
5435
5509
|
extension: string;
|
|
5436
5510
|
};
|
|
5437
5511
|
|
|
5512
|
+
/**
|
|
5513
|
+
* Unique identifier of a Chromium extension.
|
|
5514
|
+
*
|
|
5515
|
+
* @interface
|
|
5516
|
+
*/
|
|
5517
|
+
declare type ExtensionId = string;
|
|
5518
|
+
|
|
5438
5519
|
/**
|
|
5439
5520
|
* @interface
|
|
5440
5521
|
*/
|
|
@@ -6224,6 +6305,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6224
6305
|
readonly Interop: InteropModule;
|
|
6225
6306
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6226
6307
|
readonly NotificationManager: NotificationManagerModule;
|
|
6308
|
+
readonly ChromeBrowser: OpenFin.ChromeBrowser;
|
|
6227
6309
|
/**
|
|
6228
6310
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6229
6311
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -10609,6 +10691,7 @@ declare namespace OpenFin {
|
|
|
10609
10691
|
SnapshotSource,
|
|
10610
10692
|
SnapshotSourceModule,
|
|
10611
10693
|
System,
|
|
10694
|
+
Readable,
|
|
10612
10695
|
LayoutEntityDefinition,
|
|
10613
10696
|
LayoutEntityTypes,
|
|
10614
10697
|
LayoutPosition,
|
|
@@ -10641,6 +10724,10 @@ declare namespace OpenFin {
|
|
|
10641
10724
|
AnchorLocation,
|
|
10642
10725
|
Anchor,
|
|
10643
10726
|
DownloadBubbleOptions,
|
|
10727
|
+
ExtensionId,
|
|
10728
|
+
ExtensionActionListItem,
|
|
10729
|
+
ExtensionActionInvokeOptions,
|
|
10730
|
+
ChromeBrowserActions,
|
|
10644
10731
|
DisplayMetadata,
|
|
10645
10732
|
LegacyWinOptionsInAppOptions,
|
|
10646
10733
|
Snapshot,
|
|
@@ -11006,6 +11093,7 @@ declare namespace OpenFin {
|
|
|
11006
11093
|
InteropClientEvent,
|
|
11007
11094
|
ClientChangedContextGroup,
|
|
11008
11095
|
InteropClientEvents,
|
|
11096
|
+
ChromeBrowser,
|
|
11009
11097
|
ApplicationEvents,
|
|
11010
11098
|
BaseEvents,
|
|
11011
11099
|
ExternalApplicationEvents,
|
|
@@ -14178,6 +14266,14 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14178
14266
|
};
|
|
14179
14267
|
response: void;
|
|
14180
14268
|
};
|
|
14269
|
+
'chrome-browser-get-extension-actions': ApiCall<{}, {
|
|
14270
|
+
actions: OpenFin.ExtensionActionListItem[];
|
|
14271
|
+
}>;
|
|
14272
|
+
'chrome-browser-invoke-extension-action': ApiCall<{
|
|
14273
|
+
extensionId: string;
|
|
14274
|
+
anchor: OpenFin.Anchor;
|
|
14275
|
+
}, void>;
|
|
14276
|
+
'chrome-browser-hide-active-extension-popup': ApiCall<{}, void>;
|
|
14181
14277
|
};
|
|
14182
14278
|
|
|
14183
14279
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
@@ -14274,6 +14370,21 @@ declare type QueryPermissionResult = {
|
|
|
14274
14370
|
rawValue?: unknown;
|
|
14275
14371
|
};
|
|
14276
14372
|
|
|
14373
|
+
/**
|
|
14374
|
+
* A readonly implementation of the observable pattern.
|
|
14375
|
+
* Frameworks and vanilla consumers use this to read state and subscribe to changes.
|
|
14376
|
+
*/
|
|
14377
|
+
declare interface Readable<T> {
|
|
14378
|
+
/** Synchronously returns the current value. */
|
|
14379
|
+
get(): T;
|
|
14380
|
+
/**
|
|
14381
|
+
* Subscribes to changes.
|
|
14382
|
+
* @param listener A callback that is invoked when the value changes.
|
|
14383
|
+
* @returns An unsubscribe function to clean up the listener.
|
|
14384
|
+
*/
|
|
14385
|
+
subscribe(listener: () => void): () => void;
|
|
14386
|
+
}
|
|
14387
|
+
|
|
14277
14388
|
/**
|
|
14278
14389
|
* @interface
|
|
14279
14390
|
*/
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -3101,6 +3101,53 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3101
3101
|
childOptions: OpenFin.WindowOptions;
|
|
3102
3102
|
};
|
|
3103
3103
|
|
|
3104
|
+
/**
|
|
3105
|
+
* End of Interop Client Events
|
|
3106
|
+
*/
|
|
3107
|
+
/**
|
|
3108
|
+
* Client-side handle for the chrome-browser feature.
|
|
3109
|
+
*
|
|
3110
|
+
* For Chrome extension integration to be active on a window, that window must be
|
|
3111
|
+
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3112
|
+
* `init()` step.
|
|
3113
|
+
*/
|
|
3114
|
+
declare interface ChromeBrowser {
|
|
3115
|
+
/**
|
|
3116
|
+
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3117
|
+
*/
|
|
3118
|
+
readonly Actions: ChromeBrowserActions;
|
|
3119
|
+
}
|
|
3120
|
+
|
|
3121
|
+
/**
|
|
3122
|
+
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
3123
|
+
*
|
|
3124
|
+
* @interface
|
|
3125
|
+
*/
|
|
3126
|
+
declare interface ChromeBrowserActions {
|
|
3127
|
+
/**
|
|
3128
|
+
* Returns the current list of extension actions with the minimal render state
|
|
3129
|
+
* required to build a toolbar UI.
|
|
3130
|
+
*/
|
|
3131
|
+
getExtensionActions(): Promise<ExtensionActionListItem[]>;
|
|
3132
|
+
/**
|
|
3133
|
+
* Executes the specified extension action.
|
|
3134
|
+
*
|
|
3135
|
+
* @remarks
|
|
3136
|
+
* This may trigger an extension popup to be shown by the Runtime if the extension
|
|
3137
|
+
* has a popup configured for the currently active tab.
|
|
3138
|
+
*/
|
|
3139
|
+
invokeExtensionAction(options: ExtensionActionInvokeOptions): Promise<void>;
|
|
3140
|
+
/**
|
|
3141
|
+
* Hides the active extension popup, if any.
|
|
3142
|
+
*/
|
|
3143
|
+
hideActiveExtensionPopup(): Promise<void>;
|
|
3144
|
+
/**
|
|
3145
|
+
* Reactive value reflecting the current extension action list.
|
|
3146
|
+
* Compatible with React's `useSyncExternalStore`.
|
|
3147
|
+
*/
|
|
3148
|
+
readonly state: Readable<ExtensionActionListItem[]>;
|
|
3149
|
+
}
|
|
3150
|
+
|
|
3104
3151
|
/**
|
|
3105
3152
|
* Control behavior for Chromium policies
|
|
3106
3153
|
*
|
|
@@ -5428,6 +5475,33 @@ declare type ExitCode = {
|
|
|
5428
5475
|
exitCode: number;
|
|
5429
5476
|
};
|
|
5430
5477
|
|
|
5478
|
+
/**
|
|
5479
|
+
* Options for invoking an extension action.
|
|
5480
|
+
*
|
|
5481
|
+
* @interface
|
|
5482
|
+
*/
|
|
5483
|
+
declare type ExtensionActionInvokeOptions = {
|
|
5484
|
+
extensionId: ExtensionId;
|
|
5485
|
+
/** Anchor in window client coordinates (from getBoundingClientRect). */
|
|
5486
|
+
anchor: Anchor;
|
|
5487
|
+
};
|
|
5488
|
+
|
|
5489
|
+
/**
|
|
5490
|
+
* Minimal UI model required to render a list of extension actions.
|
|
5491
|
+
*
|
|
5492
|
+
* @interface
|
|
5493
|
+
*/
|
|
5494
|
+
declare type ExtensionActionListItem = {
|
|
5495
|
+
/** Stable ID for the extension that owns this action. */
|
|
5496
|
+
extensionId: ExtensionId;
|
|
5497
|
+
/** Whether to show the action button for the current context (active tab). */
|
|
5498
|
+
isVisible: boolean;
|
|
5499
|
+
/** Accessible label / title for the action button. */
|
|
5500
|
+
title: string;
|
|
5501
|
+
/** Renderer-safe icon (data URL). */
|
|
5502
|
+
iconDataUrl: string;
|
|
5503
|
+
};
|
|
5504
|
+
|
|
5431
5505
|
declare type ExtensionEvent = SecurityRealmEvent & {
|
|
5432
5506
|
/**
|
|
5433
5507
|
* Runtime extension whose status has been (possibly) modified
|
|
@@ -5435,6 +5509,13 @@ declare type ExtensionEvent = SecurityRealmEvent & {
|
|
|
5435
5509
|
extension: string;
|
|
5436
5510
|
};
|
|
5437
5511
|
|
|
5512
|
+
/**
|
|
5513
|
+
* Unique identifier of a Chromium extension.
|
|
5514
|
+
*
|
|
5515
|
+
* @interface
|
|
5516
|
+
*/
|
|
5517
|
+
declare type ExtensionId = string;
|
|
5518
|
+
|
|
5438
5519
|
/**
|
|
5439
5520
|
* @interface
|
|
5440
5521
|
*/
|
|
@@ -6224,6 +6305,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6224
6305
|
readonly Interop: InteropModule;
|
|
6225
6306
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6226
6307
|
readonly NotificationManager: NotificationManagerModule;
|
|
6308
|
+
readonly ChromeBrowser: OpenFin.ChromeBrowser;
|
|
6227
6309
|
/**
|
|
6228
6310
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6229
6311
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -10609,6 +10691,7 @@ declare namespace OpenFin {
|
|
|
10609
10691
|
SnapshotSource,
|
|
10610
10692
|
SnapshotSourceModule,
|
|
10611
10693
|
System,
|
|
10694
|
+
Readable,
|
|
10612
10695
|
LayoutEntityDefinition,
|
|
10613
10696
|
LayoutEntityTypes,
|
|
10614
10697
|
LayoutPosition,
|
|
@@ -10641,6 +10724,10 @@ declare namespace OpenFin {
|
|
|
10641
10724
|
AnchorLocation,
|
|
10642
10725
|
Anchor,
|
|
10643
10726
|
DownloadBubbleOptions,
|
|
10727
|
+
ExtensionId,
|
|
10728
|
+
ExtensionActionListItem,
|
|
10729
|
+
ExtensionActionInvokeOptions,
|
|
10730
|
+
ChromeBrowserActions,
|
|
10644
10731
|
DisplayMetadata,
|
|
10645
10732
|
LegacyWinOptionsInAppOptions,
|
|
10646
10733
|
Snapshot,
|
|
@@ -11006,6 +11093,7 @@ declare namespace OpenFin {
|
|
|
11006
11093
|
InteropClientEvent,
|
|
11007
11094
|
ClientChangedContextGroup,
|
|
11008
11095
|
InteropClientEvents,
|
|
11096
|
+
ChromeBrowser,
|
|
11009
11097
|
ApplicationEvents,
|
|
11010
11098
|
BaseEvents,
|
|
11011
11099
|
ExternalApplicationEvents,
|
|
@@ -14178,6 +14266,14 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14178
14266
|
};
|
|
14179
14267
|
response: void;
|
|
14180
14268
|
};
|
|
14269
|
+
'chrome-browser-get-extension-actions': ApiCall<{}, {
|
|
14270
|
+
actions: OpenFin.ExtensionActionListItem[];
|
|
14271
|
+
}>;
|
|
14272
|
+
'chrome-browser-invoke-extension-action': ApiCall<{
|
|
14273
|
+
extensionId: string;
|
|
14274
|
+
anchor: OpenFin.Anchor;
|
|
14275
|
+
}, void>;
|
|
14276
|
+
'chrome-browser-hide-active-extension-popup': ApiCall<{}, void>;
|
|
14181
14277
|
};
|
|
14182
14278
|
|
|
14183
14279
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
@@ -14274,6 +14370,21 @@ declare type QueryPermissionResult = {
|
|
|
14274
14370
|
rawValue?: unknown;
|
|
14275
14371
|
};
|
|
14276
14372
|
|
|
14373
|
+
/**
|
|
14374
|
+
* A readonly implementation of the observable pattern.
|
|
14375
|
+
* Frameworks and vanilla consumers use this to read state and subscribe to changes.
|
|
14376
|
+
*/
|
|
14377
|
+
declare interface Readable<T> {
|
|
14378
|
+
/** Synchronously returns the current value. */
|
|
14379
|
+
get(): T;
|
|
14380
|
+
/**
|
|
14381
|
+
* Subscribes to changes.
|
|
14382
|
+
* @param listener A callback that is invoked when the value changes.
|
|
14383
|
+
* @returns An unsubscribe function to clean up the listener.
|
|
14384
|
+
*/
|
|
14385
|
+
subscribe(listener: () => void): () => void;
|
|
14386
|
+
}
|
|
14387
|
+
|
|
14277
14388
|
/**
|
|
14278
14389
|
* @interface
|
|
14279
14390
|
*/
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -3157,6 +3157,53 @@ declare type ChildWindowCreatedEvent = ContentCreationRulesEvent & {
|
|
|
3157
3157
|
childOptions: OpenFin.WindowOptions;
|
|
3158
3158
|
};
|
|
3159
3159
|
|
|
3160
|
+
/**
|
|
3161
|
+
* End of Interop Client Events
|
|
3162
|
+
*/
|
|
3163
|
+
/**
|
|
3164
|
+
* Client-side handle for the chrome-browser feature.
|
|
3165
|
+
*
|
|
3166
|
+
* For Chrome extension integration to be active on a window, that window must be
|
|
3167
|
+
* created with `chromeBrowser: true` in its window options. There is no separate
|
|
3168
|
+
* `init()` step.
|
|
3169
|
+
*/
|
|
3170
|
+
declare interface ChromeBrowser {
|
|
3171
|
+
/**
|
|
3172
|
+
* Extension action surface — observe and invoke installed Chrome extension actions.
|
|
3173
|
+
*/
|
|
3174
|
+
readonly Actions: ChromeBrowserActions;
|
|
3175
|
+
}
|
|
3176
|
+
|
|
3177
|
+
/**
|
|
3178
|
+
* APIs for interacting with Chromium extension actions from an initialized ChromeBrowser window.
|
|
3179
|
+
*
|
|
3180
|
+
* @interface
|
|
3181
|
+
*/
|
|
3182
|
+
declare interface ChromeBrowserActions {
|
|
3183
|
+
/**
|
|
3184
|
+
* Returns the current list of extension actions with the minimal render state
|
|
3185
|
+
* required to build a toolbar UI.
|
|
3186
|
+
*/
|
|
3187
|
+
getExtensionActions(): Promise<ExtensionActionListItem[]>;
|
|
3188
|
+
/**
|
|
3189
|
+
* Executes the specified extension action.
|
|
3190
|
+
*
|
|
3191
|
+
* @remarks
|
|
3192
|
+
* This may trigger an extension popup to be shown by the Runtime if the extension
|
|
3193
|
+
* has a popup configured for the currently active tab.
|
|
3194
|
+
*/
|
|
3195
|
+
invokeExtensionAction(options: ExtensionActionInvokeOptions): Promise<void>;
|
|
3196
|
+
/**
|
|
3197
|
+
* Hides the active extension popup, if any.
|
|
3198
|
+
*/
|
|
3199
|
+
hideActiveExtensionPopup(): Promise<void>;
|
|
3200
|
+
/**
|
|
3201
|
+
* Reactive value reflecting the current extension action list.
|
|
3202
|
+
* Compatible with React's `useSyncExternalStore`.
|
|
3203
|
+
*/
|
|
3204
|
+
readonly state: Readable<ExtensionActionListItem[]>;
|
|
3205
|
+
}
|
|
3206
|
+
|
|
3160
3207
|
/**
|
|
3161
3208
|
* Control behavior for Chromium policies
|
|
3162
3209
|
*
|
|
@@ -5510,6 +5557,33 @@ declare type ExitCode = {
|
|
|
5510
5557
|
exitCode: number;
|
|
5511
5558
|
};
|
|
5512
5559
|
|
|
5560
|
+
/**
|
|
5561
|
+
* Options for invoking an extension action.
|
|
5562
|
+
*
|
|
5563
|
+
* @interface
|
|
5564
|
+
*/
|
|
5565
|
+
declare type ExtensionActionInvokeOptions = {
|
|
5566
|
+
extensionId: ExtensionId;
|
|
5567
|
+
/** Anchor in window client coordinates (from getBoundingClientRect). */
|
|
5568
|
+
anchor: Anchor;
|
|
5569
|
+
};
|
|
5570
|
+
|
|
5571
|
+
/**
|
|
5572
|
+
* Minimal UI model required to render a list of extension actions.
|
|
5573
|
+
*
|
|
5574
|
+
* @interface
|
|
5575
|
+
*/
|
|
5576
|
+
declare type ExtensionActionListItem = {
|
|
5577
|
+
/** Stable ID for the extension that owns this action. */
|
|
5578
|
+
extensionId: ExtensionId;
|
|
5579
|
+
/** Whether to show the action button for the current context (active tab). */
|
|
5580
|
+
isVisible: boolean;
|
|
5581
|
+
/** Accessible label / title for the action button. */
|
|
5582
|
+
title: string;
|
|
5583
|
+
/** Renderer-safe icon (data URL). */
|
|
5584
|
+
iconDataUrl: string;
|
|
5585
|
+
};
|
|
5586
|
+
|
|
5513
5587
|
declare type ExtensionEvent = SecurityRealmEvent & {
|
|
5514
5588
|
/**
|
|
5515
5589
|
* Runtime extension whose status has been (possibly) modified
|
|
@@ -5517,6 +5591,13 @@ declare type ExtensionEvent = SecurityRealmEvent & {
|
|
|
5517
5591
|
extension: string;
|
|
5518
5592
|
};
|
|
5519
5593
|
|
|
5594
|
+
/**
|
|
5595
|
+
* Unique identifier of a Chromium extension.
|
|
5596
|
+
*
|
|
5597
|
+
* @interface
|
|
5598
|
+
*/
|
|
5599
|
+
declare type ExtensionId = string;
|
|
5600
|
+
|
|
5520
5601
|
/**
|
|
5521
5602
|
* @interface
|
|
5522
5603
|
*/
|
|
@@ -6309,6 +6390,7 @@ declare interface FinApi<MeType extends OpenFin.EntityType> {
|
|
|
6309
6390
|
readonly Interop: InteropModule;
|
|
6310
6391
|
readonly SnapshotSource: SnapshotSourceModule;
|
|
6311
6392
|
readonly NotificationManager: NotificationManagerModule;
|
|
6393
|
+
readonly ChromeBrowser: OpenFin.ChromeBrowser;
|
|
6312
6394
|
/**
|
|
6313
6395
|
* Provides access to the OpenFin representation of the current code context (usually an entity
|
|
6314
6396
|
* such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
|
|
@@ -10943,6 +11025,7 @@ declare namespace OpenFin {
|
|
|
10943
11025
|
SnapshotSource,
|
|
10944
11026
|
SnapshotSourceModule,
|
|
10945
11027
|
System,
|
|
11028
|
+
Readable,
|
|
10946
11029
|
LayoutEntityDefinition,
|
|
10947
11030
|
LayoutEntityTypes,
|
|
10948
11031
|
LayoutPosition,
|
|
@@ -10975,6 +11058,10 @@ declare namespace OpenFin {
|
|
|
10975
11058
|
AnchorLocation,
|
|
10976
11059
|
Anchor,
|
|
10977
11060
|
DownloadBubbleOptions,
|
|
11061
|
+
ExtensionId,
|
|
11062
|
+
ExtensionActionListItem,
|
|
11063
|
+
ExtensionActionInvokeOptions,
|
|
11064
|
+
ChromeBrowserActions,
|
|
10978
11065
|
DisplayMetadata,
|
|
10979
11066
|
LegacyWinOptionsInAppOptions,
|
|
10980
11067
|
Snapshot,
|
|
@@ -11340,6 +11427,7 @@ declare namespace OpenFin {
|
|
|
11340
11427
|
InteropClientEvent,
|
|
11341
11428
|
ClientChangedContextGroup,
|
|
11342
11429
|
InteropClientEvents,
|
|
11430
|
+
ChromeBrowser,
|
|
11343
11431
|
ApplicationEvents,
|
|
11344
11432
|
BaseEvents,
|
|
11345
11433
|
ExternalApplicationEvents,
|
|
@@ -14595,6 +14683,14 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
|
|
|
14595
14683
|
};
|
|
14596
14684
|
response: void;
|
|
14597
14685
|
};
|
|
14686
|
+
'chrome-browser-get-extension-actions': ApiCall<{}, {
|
|
14687
|
+
actions: OpenFin.ExtensionActionListItem[];
|
|
14688
|
+
}>;
|
|
14689
|
+
'chrome-browser-invoke-extension-action': ApiCall<{
|
|
14690
|
+
extensionId: string;
|
|
14691
|
+
anchor: OpenFin.Anchor;
|
|
14692
|
+
}, void>;
|
|
14693
|
+
'chrome-browser-hide-active-extension-popup': ApiCall<{}, void>;
|
|
14598
14694
|
};
|
|
14599
14695
|
|
|
14600
14696
|
declare type ProtocolOffer = ClassicProtocolOffer | RTCProtocolOffer;
|
|
@@ -14691,6 +14787,21 @@ declare type QueryPermissionResult = {
|
|
|
14691
14787
|
rawValue?: unknown;
|
|
14692
14788
|
};
|
|
14693
14789
|
|
|
14790
|
+
/**
|
|
14791
|
+
* A readonly implementation of the observable pattern.
|
|
14792
|
+
* Frameworks and vanilla consumers use this to read state and subscribe to changes.
|
|
14793
|
+
*/
|
|
14794
|
+
declare interface Readable<T> {
|
|
14795
|
+
/** Synchronously returns the current value. */
|
|
14796
|
+
get(): T;
|
|
14797
|
+
/**
|
|
14798
|
+
* Subscribes to changes.
|
|
14799
|
+
* @param listener A callback that is invoked when the value changes.
|
|
14800
|
+
* @returns An unsubscribe function to clean up the listener.
|
|
14801
|
+
*/
|
|
14802
|
+
subscribe(listener: () => void): () => void;
|
|
14803
|
+
}
|
|
14804
|
+
|
|
14694
14805
|
/**
|
|
14695
14806
|
* @interface
|
|
14696
14807
|
*/
|