@openfin/fdc3-api 40.82.25 → 40.82.27

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.
@@ -4745,7 +4745,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
4745
4745
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
4746
4746
  * from which they propagate).
4747
4747
  */
4748
- declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
4748
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
4749
4749
 
4750
4750
  /**
4751
4751
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
@@ -4917,6 +4917,105 @@ declare type ExitCode = {
4917
4917
  exitCode: number;
4918
4918
  };
4919
4919
 
4920
+ declare type ExtensionEvent = SecurityRealmEvent & {
4921
+ /**
4922
+ * Runtime extension whose status has been (possibly) modified
4923
+ */
4924
+ extension: string;
4925
+ };
4926
+
4927
+ /**
4928
+ * @interface
4929
+ */
4930
+ declare type ExtensionInfo = {
4931
+ extensionId: string;
4932
+ name: string;
4933
+ enabled: boolean;
4934
+ };
4935
+
4936
+ /**
4937
+ * An event that fires when an extension is installed in the security realm.
4938
+ *
4939
+ * @interface
4940
+ */
4941
+ declare type ExtensionInstalledEvent = ExtensionEvent & {
4942
+ type: 'extension-installed';
4943
+ };
4944
+
4945
+ /**
4946
+ * An event that fires when an extension fails to install in the security realm.
4947
+ *
4948
+ * @interface
4949
+ */
4950
+ declare type ExtensionInstallFailedEvent = ExtensionEvent & {
4951
+ type: 'extension-install-failed';
4952
+ };
4953
+
4954
+ /**
4955
+ * An event that fires when extensions are disabled in the security realm.
4956
+ *
4957
+ * @interface
4958
+ */
4959
+ declare type ExtensionsDisabledEvent = ExtensionsEvent & {
4960
+ type: 'extensions-disabled';
4961
+ };
4962
+
4963
+ /**
4964
+ * An event that fires when extensions are enabled in the security realm.
4965
+ *
4966
+ * @interface
4967
+ */
4968
+ declare type ExtensionsEnabledEvent = ExtensionsEvent & {
4969
+ type: 'extensions-enabled';
4970
+ };
4971
+
4972
+ declare type ExtensionsEvent = SecurityRealmEvent & {
4973
+ /**
4974
+ * Runtime extensions whose status has been (possibly) modified
4975
+ */
4976
+ extensions: string[];
4977
+ };
4978
+
4979
+ /**
4980
+ * An event that fires when requested extensions are not allowed to be installed in the security realm.
4981
+ *
4982
+ * @interface
4983
+ */
4984
+ declare type ExtensionsExcludedEvent = ExtensionsEvent & {
4985
+ type: 'extensions-excluded';
4986
+ };
4987
+
4988
+ /**
4989
+ * An event that fires when extension initialization fails on initial app launch. Users may attempt to
4990
+ * re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
4991
+ * to manual extension refreshes (users should catch the error normally).
4992
+ */
4993
+ declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
4994
+ type: 'extensions-initialization-failed';
4995
+ /**
4996
+ * The error that caused the extension initialization failure
4997
+ */
4998
+ error: Error;
4999
+ };
5000
+
5001
+ /**
5002
+ * An event that fires when extensions are installed in the security realm.
5003
+ *
5004
+ * @interface
5005
+ */
5006
+ declare type ExtensionsInstalledEvent = ExtensionsEvent & {
5007
+ type: 'extensions-installed';
5008
+ };
5009
+
5010
+ /**
5011
+ * An event that fires when extensions fail to install in the security realm.
5012
+ *
5013
+ * @interface
5014
+ */
5015
+ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
5016
+ type: 'extensions-install-failed';
5017
+ };
5018
+
4920
5019
  /**
4921
5020
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
4922
5021
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
@@ -9803,6 +9902,7 @@ declare namespace OpenFin {
9803
9902
  RoutingInfo,
9804
9903
  DownloadShelfOptions,
9805
9904
  ViewShowAtOptions,
9905
+ ExtensionInfo,
9806
9906
  ApplicationEvents,
9807
9907
  BaseEvents,
9808
9908
  ExternalApplicationEvents,
@@ -12487,6 +12587,14 @@ declare interface ProtocolMap extends ProtocolMapBase {
12487
12587
  }, void>;
12488
12588
  'system-register-shutdown-handler': VoidCall;
12489
12589
  'get-permissions': GetterCall<any>;
12590
+ 'refresh-extensions': {
12591
+ request: void;
12592
+ response: string[] | undefined;
12593
+ };
12594
+ 'get-installed-extensions': {
12595
+ request: void;
12596
+ response: OpenFin.ExtensionInfo[];
12597
+ };
12490
12598
  'fdc3-add-context-listener': VoidCall;
12491
12599
  'fdc3-add-intent-listener': VoidCall;
12492
12600
  'fdc3-raise-intent': VoidCall;
@@ -13175,6 +13283,21 @@ declare type ScreenshotPrintOptions = {
13175
13283
  content: 'screenshot';
13176
13284
  };
13177
13285
 
13286
+ /**
13287
+ * An event generated when an application modifies the runtime in a way that affects all other applications in the
13288
+ * application runtime/security realm.
13289
+ */
13290
+ declare type SecurityRealmEvent = BaseEvent_9 & {
13291
+ /**
13292
+ * Config URL of the application that modified the security realm's extensions
13293
+ */
13294
+ configUrl: string;
13295
+ /**
13296
+ * Identity of the application that modified the security realm's extensions
13297
+ */
13298
+ applicationIdentity: OpenFin.ApplicationIdentity;
13299
+ };
13300
+
13178
13301
  declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
13179
13302
  data: ProtocolMap[T]['response'];
13180
13303
  } & ProtocolMap[T]['specialResponse']>;
@@ -15066,6 +15189,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15066
15189
  * ```
15067
15190
  */
15068
15191
  setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
15192
+ /**
15193
+ * Attempts to install and enable extensions for the security realm. Users may want to call this function in response
15194
+ * to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
15195
+ * will be installed/enabled.
15196
+ */
15197
+ refreshExtensions(): Promise<string[] | undefined>;
15198
+ /**
15199
+ * Gets the currently-installed
15200
+ */
15201
+ getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15069
15202
  }
15070
15203
 
15071
15204
  /**
@@ -15096,6 +15229,14 @@ declare namespace SystemEvents {
15096
15229
  ApplicationCreatedEvent,
15097
15230
  DesktopIconClickedEvent,
15098
15231
  SystemShutdownEvent,
15232
+ ExtensionsEnabledEvent,
15233
+ ExtensionsDisabledEvent,
15234
+ ExtensionsExcludedEvent,
15235
+ ExtensionsInstalledEvent,
15236
+ ExtensionInstalledEvent,
15237
+ ExtensionsInstallFailedEvent,
15238
+ ExtensionInstallFailedEvent,
15239
+ ExtensionsInitializationFailedEvent,
15099
15240
  Event_11 as Event,
15100
15241
  SystemEvent,
15101
15242
  EventType_8 as EventType,
@@ -16383,6 +16524,9 @@ declare class ViewModule extends Base {
16383
16524
  */
16384
16525
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16385
16526
 
16527
+ /**
16528
+ * @interface
16529
+ */
16386
16530
  declare type ViewShowAtOptions = {
16387
16531
  /**
16388
16532
  * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
@@ -4745,7 +4745,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
4745
4745
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
4746
4746
  * from which they propagate).
4747
4747
  */
4748
- declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
4748
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
4749
4749
 
4750
4750
  /**
4751
4751
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
@@ -4917,6 +4917,105 @@ declare type ExitCode = {
4917
4917
  exitCode: number;
4918
4918
  };
4919
4919
 
4920
+ declare type ExtensionEvent = SecurityRealmEvent & {
4921
+ /**
4922
+ * Runtime extension whose status has been (possibly) modified
4923
+ */
4924
+ extension: string;
4925
+ };
4926
+
4927
+ /**
4928
+ * @interface
4929
+ */
4930
+ declare type ExtensionInfo = {
4931
+ extensionId: string;
4932
+ name: string;
4933
+ enabled: boolean;
4934
+ };
4935
+
4936
+ /**
4937
+ * An event that fires when an extension is installed in the security realm.
4938
+ *
4939
+ * @interface
4940
+ */
4941
+ declare type ExtensionInstalledEvent = ExtensionEvent & {
4942
+ type: 'extension-installed';
4943
+ };
4944
+
4945
+ /**
4946
+ * An event that fires when an extension fails to install in the security realm.
4947
+ *
4948
+ * @interface
4949
+ */
4950
+ declare type ExtensionInstallFailedEvent = ExtensionEvent & {
4951
+ type: 'extension-install-failed';
4952
+ };
4953
+
4954
+ /**
4955
+ * An event that fires when extensions are disabled in the security realm.
4956
+ *
4957
+ * @interface
4958
+ */
4959
+ declare type ExtensionsDisabledEvent = ExtensionsEvent & {
4960
+ type: 'extensions-disabled';
4961
+ };
4962
+
4963
+ /**
4964
+ * An event that fires when extensions are enabled in the security realm.
4965
+ *
4966
+ * @interface
4967
+ */
4968
+ declare type ExtensionsEnabledEvent = ExtensionsEvent & {
4969
+ type: 'extensions-enabled';
4970
+ };
4971
+
4972
+ declare type ExtensionsEvent = SecurityRealmEvent & {
4973
+ /**
4974
+ * Runtime extensions whose status has been (possibly) modified
4975
+ */
4976
+ extensions: string[];
4977
+ };
4978
+
4979
+ /**
4980
+ * An event that fires when requested extensions are not allowed to be installed in the security realm.
4981
+ *
4982
+ * @interface
4983
+ */
4984
+ declare type ExtensionsExcludedEvent = ExtensionsEvent & {
4985
+ type: 'extensions-excluded';
4986
+ };
4987
+
4988
+ /**
4989
+ * An event that fires when extension initialization fails on initial app launch. Users may attempt to
4990
+ * re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
4991
+ * to manual extension refreshes (users should catch the error normally).
4992
+ */
4993
+ declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
4994
+ type: 'extensions-initialization-failed';
4995
+ /**
4996
+ * The error that caused the extension initialization failure
4997
+ */
4998
+ error: Error;
4999
+ };
5000
+
5001
+ /**
5002
+ * An event that fires when extensions are installed in the security realm.
5003
+ *
5004
+ * @interface
5005
+ */
5006
+ declare type ExtensionsInstalledEvent = ExtensionsEvent & {
5007
+ type: 'extensions-installed';
5008
+ };
5009
+
5010
+ /**
5011
+ * An event that fires when extensions fail to install in the security realm.
5012
+ *
5013
+ * @interface
5014
+ */
5015
+ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
5016
+ type: 'extensions-install-failed';
5017
+ };
5018
+
4920
5019
  /**
4921
5020
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
4922
5021
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
@@ -9803,6 +9902,7 @@ declare namespace OpenFin {
9803
9902
  RoutingInfo,
9804
9903
  DownloadShelfOptions,
9805
9904
  ViewShowAtOptions,
9905
+ ExtensionInfo,
9806
9906
  ApplicationEvents,
9807
9907
  BaseEvents,
9808
9908
  ExternalApplicationEvents,
@@ -12487,6 +12587,14 @@ declare interface ProtocolMap extends ProtocolMapBase {
12487
12587
  }, void>;
12488
12588
  'system-register-shutdown-handler': VoidCall;
12489
12589
  'get-permissions': GetterCall<any>;
12590
+ 'refresh-extensions': {
12591
+ request: void;
12592
+ response: string[] | undefined;
12593
+ };
12594
+ 'get-installed-extensions': {
12595
+ request: void;
12596
+ response: OpenFin.ExtensionInfo[];
12597
+ };
12490
12598
  'fdc3-add-context-listener': VoidCall;
12491
12599
  'fdc3-add-intent-listener': VoidCall;
12492
12600
  'fdc3-raise-intent': VoidCall;
@@ -13175,6 +13283,21 @@ declare type ScreenshotPrintOptions = {
13175
13283
  content: 'screenshot';
13176
13284
  };
13177
13285
 
13286
+ /**
13287
+ * An event generated when an application modifies the runtime in a way that affects all other applications in the
13288
+ * application runtime/security realm.
13289
+ */
13290
+ declare type SecurityRealmEvent = BaseEvent_9 & {
13291
+ /**
13292
+ * Config URL of the application that modified the security realm's extensions
13293
+ */
13294
+ configUrl: string;
13295
+ /**
13296
+ * Identity of the application that modified the security realm's extensions
13297
+ */
13298
+ applicationIdentity: OpenFin.ApplicationIdentity;
13299
+ };
13300
+
13178
13301
  declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
13179
13302
  data: ProtocolMap[T]['response'];
13180
13303
  } & ProtocolMap[T]['specialResponse']>;
@@ -15066,6 +15189,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15066
15189
  * ```
15067
15190
  */
15068
15191
  setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
15192
+ /**
15193
+ * Attempts to install and enable extensions for the security realm. Users may want to call this function in response
15194
+ * to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
15195
+ * will be installed/enabled.
15196
+ */
15197
+ refreshExtensions(): Promise<string[] | undefined>;
15198
+ /**
15199
+ * Gets the currently-installed
15200
+ */
15201
+ getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15069
15202
  }
15070
15203
 
15071
15204
  /**
@@ -15096,6 +15229,14 @@ declare namespace SystemEvents {
15096
15229
  ApplicationCreatedEvent,
15097
15230
  DesktopIconClickedEvent,
15098
15231
  SystemShutdownEvent,
15232
+ ExtensionsEnabledEvent,
15233
+ ExtensionsDisabledEvent,
15234
+ ExtensionsExcludedEvent,
15235
+ ExtensionsInstalledEvent,
15236
+ ExtensionInstalledEvent,
15237
+ ExtensionsInstallFailedEvent,
15238
+ ExtensionInstallFailedEvent,
15239
+ ExtensionsInitializationFailedEvent,
15099
15240
  Event_11 as Event,
15100
15241
  SystemEvent,
15101
15242
  EventType_8 as EventType,
@@ -16383,6 +16524,9 @@ declare class ViewModule extends Base {
16383
16524
  */
16384
16525
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16385
16526
 
16527
+ /**
16528
+ * @interface
16529
+ */
16386
16530
  declare type ViewShowAtOptions = {
16387
16531
  /**
16388
16532
  * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
@@ -4745,7 +4745,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
4745
4745
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
4746
4746
  * from which they propagate).
4747
4747
  */
4748
- declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
4748
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
4749
4749
 
4750
4750
  /**
4751
4751
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
@@ -4917,6 +4917,105 @@ declare type ExitCode = {
4917
4917
  exitCode: number;
4918
4918
  };
4919
4919
 
4920
+ declare type ExtensionEvent = SecurityRealmEvent & {
4921
+ /**
4922
+ * Runtime extension whose status has been (possibly) modified
4923
+ */
4924
+ extension: string;
4925
+ };
4926
+
4927
+ /**
4928
+ * @interface
4929
+ */
4930
+ declare type ExtensionInfo = {
4931
+ extensionId: string;
4932
+ name: string;
4933
+ enabled: boolean;
4934
+ };
4935
+
4936
+ /**
4937
+ * An event that fires when an extension is installed in the security realm.
4938
+ *
4939
+ * @interface
4940
+ */
4941
+ declare type ExtensionInstalledEvent = ExtensionEvent & {
4942
+ type: 'extension-installed';
4943
+ };
4944
+
4945
+ /**
4946
+ * An event that fires when an extension fails to install in the security realm.
4947
+ *
4948
+ * @interface
4949
+ */
4950
+ declare type ExtensionInstallFailedEvent = ExtensionEvent & {
4951
+ type: 'extension-install-failed';
4952
+ };
4953
+
4954
+ /**
4955
+ * An event that fires when extensions are disabled in the security realm.
4956
+ *
4957
+ * @interface
4958
+ */
4959
+ declare type ExtensionsDisabledEvent = ExtensionsEvent & {
4960
+ type: 'extensions-disabled';
4961
+ };
4962
+
4963
+ /**
4964
+ * An event that fires when extensions are enabled in the security realm.
4965
+ *
4966
+ * @interface
4967
+ */
4968
+ declare type ExtensionsEnabledEvent = ExtensionsEvent & {
4969
+ type: 'extensions-enabled';
4970
+ };
4971
+
4972
+ declare type ExtensionsEvent = SecurityRealmEvent & {
4973
+ /**
4974
+ * Runtime extensions whose status has been (possibly) modified
4975
+ */
4976
+ extensions: string[];
4977
+ };
4978
+
4979
+ /**
4980
+ * An event that fires when requested extensions are not allowed to be installed in the security realm.
4981
+ *
4982
+ * @interface
4983
+ */
4984
+ declare type ExtensionsExcludedEvent = ExtensionsEvent & {
4985
+ type: 'extensions-excluded';
4986
+ };
4987
+
4988
+ /**
4989
+ * An event that fires when extension initialization fails on initial app launch. Users may attempt to
4990
+ * re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
4991
+ * to manual extension refreshes (users should catch the error normally).
4992
+ */
4993
+ declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
4994
+ type: 'extensions-initialization-failed';
4995
+ /**
4996
+ * The error that caused the extension initialization failure
4997
+ */
4998
+ error: Error;
4999
+ };
5000
+
5001
+ /**
5002
+ * An event that fires when extensions are installed in the security realm.
5003
+ *
5004
+ * @interface
5005
+ */
5006
+ declare type ExtensionsInstalledEvent = ExtensionsEvent & {
5007
+ type: 'extensions-installed';
5008
+ };
5009
+
5010
+ /**
5011
+ * An event that fires when extensions fail to install in the security realm.
5012
+ *
5013
+ * @interface
5014
+ */
5015
+ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
5016
+ type: 'extensions-install-failed';
5017
+ };
5018
+
4920
5019
  /**
4921
5020
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
4922
5021
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
@@ -9803,6 +9902,7 @@ declare namespace OpenFin {
9803
9902
  RoutingInfo,
9804
9903
  DownloadShelfOptions,
9805
9904
  ViewShowAtOptions,
9905
+ ExtensionInfo,
9806
9906
  ApplicationEvents,
9807
9907
  BaseEvents,
9808
9908
  ExternalApplicationEvents,
@@ -12487,6 +12587,14 @@ declare interface ProtocolMap extends ProtocolMapBase {
12487
12587
  }, void>;
12488
12588
  'system-register-shutdown-handler': VoidCall;
12489
12589
  'get-permissions': GetterCall<any>;
12590
+ 'refresh-extensions': {
12591
+ request: void;
12592
+ response: string[] | undefined;
12593
+ };
12594
+ 'get-installed-extensions': {
12595
+ request: void;
12596
+ response: OpenFin.ExtensionInfo[];
12597
+ };
12490
12598
  'fdc3-add-context-listener': VoidCall;
12491
12599
  'fdc3-add-intent-listener': VoidCall;
12492
12600
  'fdc3-raise-intent': VoidCall;
@@ -13175,6 +13283,21 @@ declare type ScreenshotPrintOptions = {
13175
13283
  content: 'screenshot';
13176
13284
  };
13177
13285
 
13286
+ /**
13287
+ * An event generated when an application modifies the runtime in a way that affects all other applications in the
13288
+ * application runtime/security realm.
13289
+ */
13290
+ declare type SecurityRealmEvent = BaseEvent_9 & {
13291
+ /**
13292
+ * Config URL of the application that modified the security realm's extensions
13293
+ */
13294
+ configUrl: string;
13295
+ /**
13296
+ * Identity of the application that modified the security realm's extensions
13297
+ */
13298
+ applicationIdentity: OpenFin.ApplicationIdentity;
13299
+ };
13300
+
13178
13301
  declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
13179
13302
  data: ProtocolMap[T]['response'];
13180
13303
  } & ProtocolMap[T]['specialResponse']>;
@@ -15066,6 +15189,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15066
15189
  * ```
15067
15190
  */
15068
15191
  setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
15192
+ /**
15193
+ * Attempts to install and enable extensions for the security realm. Users may want to call this function in response
15194
+ * to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
15195
+ * will be installed/enabled.
15196
+ */
15197
+ refreshExtensions(): Promise<string[] | undefined>;
15198
+ /**
15199
+ * Gets the currently-installed
15200
+ */
15201
+ getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15069
15202
  }
15070
15203
 
15071
15204
  /**
@@ -15096,6 +15229,14 @@ declare namespace SystemEvents {
15096
15229
  ApplicationCreatedEvent,
15097
15230
  DesktopIconClickedEvent,
15098
15231
  SystemShutdownEvent,
15232
+ ExtensionsEnabledEvent,
15233
+ ExtensionsDisabledEvent,
15234
+ ExtensionsExcludedEvent,
15235
+ ExtensionsInstalledEvent,
15236
+ ExtensionInstalledEvent,
15237
+ ExtensionsInstallFailedEvent,
15238
+ ExtensionInstallFailedEvent,
15239
+ ExtensionsInitializationFailedEvent,
15099
15240
  Event_11 as Event,
15100
15241
  SystemEvent,
15101
15242
  EventType_8 as EventType,
@@ -16383,6 +16524,9 @@ declare class ViewModule extends Base {
16383
16524
  */
16384
16525
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16385
16526
 
16527
+ /**
16528
+ * @interface
16529
+ */
16386
16530
  declare type ViewShowAtOptions = {
16387
16531
  /**
16388
16532
  * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
package/out/fdc3-api.d.ts CHANGED
@@ -4809,7 +4809,7 @@ declare type Event_10 = ApplicationEvents.Event | ApiReadyEvent | SnapshotApplie
4809
4809
  * under the {@link OpenFin.SystemEvents} namespace (payloads inherited from propagated events are defined in the namespace
4810
4810
  * from which they propagate).
4811
4811
  */
4812
- declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent;
4812
+ declare type Event_11 = ExcludeRequested<WindowEvents.PropagatedEvent<'system'>> | ExcludeRequested<ViewEvents.PropagatedEvent<'system'>> | ExcludeRequested<ApplicationEvents.PropagatedEvent<'system'>> | ApplicationCreatedEvent | DesktopIconClickedEvent | IdleStateChangedEvent | MonitorInfoChangedEvent | SessionChangedEvent | AppVersionEventWithId | SystemShutdownEvent | ExtensionsEnabledEvent | ExtensionsDisabledEvent | ExtensionsExcludedEvent | ExtensionsInstalledEvent | ExtensionInstalledEvent | ExtensionsInstallFailedEvent | ExtensionInstallFailedEvent | ExtensionsInitializationFailedEvent;
4813
4813
 
4814
4814
  /**
4815
4815
  * [Union](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#union-types) containing every possible event that can be emitted by the HTMLElement Layout container.
@@ -4999,6 +4999,105 @@ declare type ExitCode = {
4999
4999
  exitCode: number;
5000
5000
  };
5001
5001
 
5002
+ declare type ExtensionEvent = SecurityRealmEvent & {
5003
+ /**
5004
+ * Runtime extension whose status has been (possibly) modified
5005
+ */
5006
+ extension: string;
5007
+ };
5008
+
5009
+ /**
5010
+ * @interface
5011
+ */
5012
+ declare type ExtensionInfo = {
5013
+ extensionId: string;
5014
+ name: string;
5015
+ enabled: boolean;
5016
+ };
5017
+
5018
+ /**
5019
+ * An event that fires when an extension is installed in the security realm.
5020
+ *
5021
+ * @interface
5022
+ */
5023
+ declare type ExtensionInstalledEvent = ExtensionEvent & {
5024
+ type: 'extension-installed';
5025
+ };
5026
+
5027
+ /**
5028
+ * An event that fires when an extension fails to install in the security realm.
5029
+ *
5030
+ * @interface
5031
+ */
5032
+ declare type ExtensionInstallFailedEvent = ExtensionEvent & {
5033
+ type: 'extension-install-failed';
5034
+ };
5035
+
5036
+ /**
5037
+ * An event that fires when extensions are disabled in the security realm.
5038
+ *
5039
+ * @interface
5040
+ */
5041
+ declare type ExtensionsDisabledEvent = ExtensionsEvent & {
5042
+ type: 'extensions-disabled';
5043
+ };
5044
+
5045
+ /**
5046
+ * An event that fires when extensions are enabled in the security realm.
5047
+ *
5048
+ * @interface
5049
+ */
5050
+ declare type ExtensionsEnabledEvent = ExtensionsEvent & {
5051
+ type: 'extensions-enabled';
5052
+ };
5053
+
5054
+ declare type ExtensionsEvent = SecurityRealmEvent & {
5055
+ /**
5056
+ * Runtime extensions whose status has been (possibly) modified
5057
+ */
5058
+ extensions: string[];
5059
+ };
5060
+
5061
+ /**
5062
+ * An event that fires when requested extensions are not allowed to be installed in the security realm.
5063
+ *
5064
+ * @interface
5065
+ */
5066
+ declare type ExtensionsExcludedEvent = ExtensionsEvent & {
5067
+ type: 'extensions-excluded';
5068
+ };
5069
+
5070
+ /**
5071
+ * An event that fires when extension initialization fails on initial app launch. Users may attempt to
5072
+ * re-initialize extensions by calling {@link System.refreshExtensions}. This event will not fire in response
5073
+ * to manual extension refreshes (users should catch the error normally).
5074
+ */
5075
+ declare type ExtensionsInitializationFailedEvent = Omit<ExtensionsEvent, 'extensions'> & {
5076
+ type: 'extensions-initialization-failed';
5077
+ /**
5078
+ * The error that caused the extension initialization failure
5079
+ */
5080
+ error: Error;
5081
+ };
5082
+
5083
+ /**
5084
+ * An event that fires when extensions are installed in the security realm.
5085
+ *
5086
+ * @interface
5087
+ */
5088
+ declare type ExtensionsInstalledEvent = ExtensionsEvent & {
5089
+ type: 'extensions-installed';
5090
+ };
5091
+
5092
+ /**
5093
+ * An event that fires when extensions fail to install in the security realm.
5094
+ *
5095
+ * @interface
5096
+ */
5097
+ declare type ExtensionsInstallFailedEvent = ExtensionsEvent & {
5098
+ type: 'extensions-install-failed';
5099
+ };
5100
+
5002
5101
  /**
5003
5102
  * An ExternalApplication object representing native language adapter connections to the runtime. Allows
5004
5103
  * the developer to listen to {@link OpenFin.ExternalApplicationEvents external application events}.
@@ -10121,6 +10220,7 @@ declare namespace OpenFin {
10121
10220
  RoutingInfo,
10122
10221
  DownloadShelfOptions,
10123
10222
  ViewShowAtOptions,
10223
+ ExtensionInfo,
10124
10224
  ApplicationEvents,
10125
10225
  BaseEvents,
10126
10226
  ExternalApplicationEvents,
@@ -12888,6 +12988,14 @@ declare interface ProtocolMap extends ProtocolMapBase {
12888
12988
  }, void>;
12889
12989
  'system-register-shutdown-handler': VoidCall;
12890
12990
  'get-permissions': GetterCall<any>;
12991
+ 'refresh-extensions': {
12992
+ request: void;
12993
+ response: string[] | undefined;
12994
+ };
12995
+ 'get-installed-extensions': {
12996
+ request: void;
12997
+ response: OpenFin.ExtensionInfo[];
12998
+ };
12891
12999
  'fdc3-add-context-listener': VoidCall;
12892
13000
  'fdc3-add-intent-listener': VoidCall;
12893
13001
  'fdc3-raise-intent': VoidCall;
@@ -13576,6 +13684,21 @@ declare type ScreenshotPrintOptions = {
13576
13684
  content: 'screenshot';
13577
13685
  };
13578
13686
 
13687
+ /**
13688
+ * An event generated when an application modifies the runtime in a way that affects all other applications in the
13689
+ * application runtime/security realm.
13690
+ */
13691
+ declare type SecurityRealmEvent = BaseEvent_9 & {
13692
+ /**
13693
+ * Config URL of the application that modified the security realm's extensions
13694
+ */
13695
+ configUrl: string;
13696
+ /**
13697
+ * Identity of the application that modified the security realm's extensions
13698
+ */
13699
+ applicationIdentity: OpenFin.ApplicationIdentity;
13700
+ };
13701
+
13579
13702
  declare type SendActionResponse<T extends keyof ProtocolMap> = Message<{
13580
13703
  data: ProtocolMap[T]['response'];
13581
13704
  } & ProtocolMap[T]['specialResponse']>;
@@ -15473,6 +15596,16 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15473
15596
  * ```
15474
15597
  */
15475
15598
  setDomainSettings(domainSettings: OpenFin.DefaultDomainSettings): Promise<void>;
15599
+ /**
15600
+ * Attempts to install and enable extensions for the security realm. Users may want to call this function in response
15601
+ * to an `extensions-install-failed` event. Only extensions allowed by every application on the current security realm
15602
+ * will be installed/enabled.
15603
+ */
15604
+ refreshExtensions(): Promise<string[] | undefined>;
15605
+ /**
15606
+ * Gets the currently-installed
15607
+ */
15608
+ getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15476
15609
  }
15477
15610
 
15478
15611
  /**
@@ -15503,6 +15636,14 @@ declare namespace SystemEvents {
15503
15636
  ApplicationCreatedEvent,
15504
15637
  DesktopIconClickedEvent,
15505
15638
  SystemShutdownEvent,
15639
+ ExtensionsEnabledEvent,
15640
+ ExtensionsDisabledEvent,
15641
+ ExtensionsExcludedEvent,
15642
+ ExtensionsInstalledEvent,
15643
+ ExtensionInstalledEvent,
15644
+ ExtensionsInstallFailedEvent,
15645
+ ExtensionInstallFailedEvent,
15646
+ ExtensionsInitializationFailedEvent,
15506
15647
  Event_11 as Event,
15507
15648
  SystemEvent,
15508
15649
  EventType_8 as EventType,
@@ -16834,6 +16975,9 @@ declare class ViewModule extends Base {
16834
16975
  */
16835
16976
  declare type ViewOptions = ConstViewOptions & MutableViewOptions;
16836
16977
 
16978
+ /**
16979
+ * @interface
16980
+ */
16837
16981
  declare type ViewShowAtOptions = {
16838
16982
  /**
16839
16983
  * Sets the view as the top level view. See {@link OpenFin.View.bringToFront} for more information.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "40.82.25",
3
+ "version": "40.82.27",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,