@openfin/fdc3-api 40.83.12 → 40.100.2
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 +63 -12
- package/out/fdc3-api-beta.d.ts +63 -12
- package/out/fdc3-api-public.d.ts +63 -12
- package/out/fdc3-api.d.ts +63 -12
- package/package.json +1 -1
package/out/fdc3-api-alpha.d.ts
CHANGED
|
@@ -1661,6 +1661,8 @@ declare type BaseConfig = {
|
|
|
1661
1661
|
timeout?: number;
|
|
1662
1662
|
};
|
|
1663
1663
|
|
|
1664
|
+
declare type BaseContentBehavior = 'allow' | 'block';
|
|
1665
|
+
|
|
1664
1666
|
/**
|
|
1665
1667
|
* Properties shared by all content creation rules, regardless of context.
|
|
1666
1668
|
*
|
|
@@ -1804,6 +1806,10 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1804
1806
|
isMainFrame: boolean;
|
|
1805
1807
|
};
|
|
1806
1808
|
|
|
1809
|
+
declare type BaseStructuredContentBehavior = {
|
|
1810
|
+
behavior: BaseContentBehavior;
|
|
1811
|
+
};
|
|
1812
|
+
|
|
1807
1813
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1808
1814
|
type: 'url-changed';
|
|
1809
1815
|
url: string;
|
|
@@ -1904,6 +1910,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
|
1904
1910
|
|
|
1905
1911
|
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1906
1912
|
|
|
1913
|
+
declare type BrowserContentBehavior = {
|
|
1914
|
+
behavior: 'browser';
|
|
1915
|
+
/**
|
|
1916
|
+
* Additional property that can be specified when setting the behavior to browser.
|
|
1917
|
+
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
|
1918
|
+
*/
|
|
1919
|
+
closeExisting?: boolean;
|
|
1920
|
+
};
|
|
1921
|
+
|
|
1907
1922
|
/**
|
|
1908
1923
|
* A rule prescribing content creation in the browser.
|
|
1909
1924
|
*
|
|
@@ -3720,6 +3735,15 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3720
3735
|
type: 'container-created';
|
|
3721
3736
|
};
|
|
3722
3737
|
|
|
3738
|
+
/**
|
|
3739
|
+
* Sets the behavior for when a Window or View navigates or redirects to a matching URL
|
|
3740
|
+
*
|
|
3741
|
+
* 'allow': The content url is allowed.
|
|
3742
|
+
* 'block': The content url is blocked.
|
|
3743
|
+
* 'browser': The content url is blocked and it is opened in the system's default web browser.
|
|
3744
|
+
*/
|
|
3745
|
+
declare type ContentBehavior = BaseContentBehavior | 'browser';
|
|
3746
|
+
|
|
3723
3747
|
/**
|
|
3724
3748
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3725
3749
|
* @interface
|
|
@@ -3807,12 +3831,9 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3807
3831
|
declare type ContentNavigation = NavigationRules;
|
|
3808
3832
|
|
|
3809
3833
|
/**
|
|
3810
|
-
*
|
|
3811
|
-
*
|
|
3812
|
-
* * 'allow': The content url is allowed.
|
|
3813
|
-
* * 'block': The content url is blocked.
|
|
3834
|
+
* Controls whether a content url is allowed or blocked for navigation in Windows and Views or redirection for Windows, Views and iframes.
|
|
3814
3835
|
*/
|
|
3815
|
-
declare type ContentPermission =
|
|
3836
|
+
declare type ContentPermission = ContentBehavior | StructuredContentBehavior | StructuredContentPermissions;
|
|
3816
3837
|
|
|
3817
3838
|
/**
|
|
3818
3839
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
@@ -9426,13 +9447,14 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
|
9426
9447
|
};
|
|
9427
9448
|
|
|
9428
9449
|
/**
|
|
9429
|
-
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
|
9450
|
+
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules or when blocked by a domain-based permission content rule.
|
|
9430
9451
|
* @interface
|
|
9431
9452
|
*/
|
|
9432
9453
|
declare type NavigationRejectedEvent = NamedEvent & {
|
|
9433
9454
|
type: 'navigation-rejected';
|
|
9434
9455
|
sourceName?: string;
|
|
9435
9456
|
url: string;
|
|
9457
|
+
contentRule?: OpenFin.ContentPermission | undefined;
|
|
9436
9458
|
};
|
|
9437
9459
|
|
|
9438
9460
|
/**
|
|
@@ -9794,6 +9816,12 @@ declare namespace OpenFin {
|
|
|
9794
9816
|
DomainSettings,
|
|
9795
9817
|
ApiInjection,
|
|
9796
9818
|
DomainApiSettings,
|
|
9819
|
+
BaseContentBehavior,
|
|
9820
|
+
ContentBehavior,
|
|
9821
|
+
BaseStructuredContentBehavior,
|
|
9822
|
+
BrowserContentBehavior,
|
|
9823
|
+
StructuredContentBehavior,
|
|
9824
|
+
StructuredContentPermissions,
|
|
9797
9825
|
ContentPermission,
|
|
9798
9826
|
PerDomainSettings,
|
|
9799
9827
|
DomainSettingsRule,
|
|
@@ -13735,6 +13763,29 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
13735
13763
|
type: 'started';
|
|
13736
13764
|
};
|
|
13737
13765
|
|
|
13766
|
+
/**
|
|
13767
|
+
* Allows more control over content behaviors
|
|
13768
|
+
*/
|
|
13769
|
+
declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
|
|
13770
|
+
|
|
13771
|
+
/**
|
|
13772
|
+
* Specify rules for specific actions.
|
|
13773
|
+
*/
|
|
13774
|
+
declare type StructuredContentPermissions = {
|
|
13775
|
+
/**
|
|
13776
|
+
* Controls the behavior for navigations
|
|
13777
|
+
*/
|
|
13778
|
+
navigate?: ContentBehavior | StructuredContentBehavior;
|
|
13779
|
+
/**
|
|
13780
|
+
* Controls the behavior for redirects
|
|
13781
|
+
*/
|
|
13782
|
+
redirect?: ContentBehavior | StructuredContentBehavior;
|
|
13783
|
+
/**
|
|
13784
|
+
* Controls the behavior for when iframes try to redirect
|
|
13785
|
+
*/
|
|
13786
|
+
iframe?: BaseContentBehavior;
|
|
13787
|
+
};
|
|
13788
|
+
|
|
13738
13789
|
/**
|
|
13739
13790
|
* @interface
|
|
13740
13791
|
*/
|
|
@@ -17244,7 +17295,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17244
17295
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17245
17296
|
* });
|
|
17246
17297
|
*
|
|
17247
|
-
* await view.navigate('
|
|
17298
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17248
17299
|
*
|
|
17249
17300
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17250
17301
|
* ```
|
|
@@ -17255,7 +17306,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17255
17306
|
* name:'child',
|
|
17256
17307
|
* defaultWidth: 300,
|
|
17257
17308
|
* defaultHeight: 300,
|
|
17258
|
-
* url: '
|
|
17309
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17259
17310
|
* frame: true,
|
|
17260
17311
|
* autoShow: true
|
|
17261
17312
|
* };
|
|
@@ -17280,7 +17331,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17280
17331
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17281
17332
|
* });
|
|
17282
17333
|
*
|
|
17283
|
-
* await view.navigate('
|
|
17334
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17284
17335
|
*
|
|
17285
17336
|
* await view.inspectSharedWorker();
|
|
17286
17337
|
* ```
|
|
@@ -17291,7 +17342,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17291
17342
|
* name:'child',
|
|
17292
17343
|
* defaultWidth: 300,
|
|
17293
17344
|
* defaultHeight: 300,
|
|
17294
|
-
* url: '
|
|
17345
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17295
17346
|
* frame: true,
|
|
17296
17347
|
* autoShow: true
|
|
17297
17348
|
* };
|
|
@@ -17317,7 +17368,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17317
17368
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17318
17369
|
* });
|
|
17319
17370
|
*
|
|
17320
|
-
* await view.navigate('
|
|
17371
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17321
17372
|
*
|
|
17322
17373
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17323
17374
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -17329,7 +17380,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17329
17380
|
* name:'child',
|
|
17330
17381
|
* defaultWidth: 300,
|
|
17331
17382
|
* defaultHeight: 300,
|
|
17332
|
-
* url: '
|
|
17383
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17333
17384
|
* frame: true,
|
|
17334
17385
|
* autoShow: true
|
|
17335
17386
|
* };
|
package/out/fdc3-api-beta.d.ts
CHANGED
|
@@ -1661,6 +1661,8 @@ declare type BaseConfig = {
|
|
|
1661
1661
|
timeout?: number;
|
|
1662
1662
|
};
|
|
1663
1663
|
|
|
1664
|
+
declare type BaseContentBehavior = 'allow' | 'block';
|
|
1665
|
+
|
|
1664
1666
|
/**
|
|
1665
1667
|
* Properties shared by all content creation rules, regardless of context.
|
|
1666
1668
|
*
|
|
@@ -1804,6 +1806,10 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1804
1806
|
isMainFrame: boolean;
|
|
1805
1807
|
};
|
|
1806
1808
|
|
|
1809
|
+
declare type BaseStructuredContentBehavior = {
|
|
1810
|
+
behavior: BaseContentBehavior;
|
|
1811
|
+
};
|
|
1812
|
+
|
|
1807
1813
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1808
1814
|
type: 'url-changed';
|
|
1809
1815
|
url: string;
|
|
@@ -1904,6 +1910,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
|
1904
1910
|
|
|
1905
1911
|
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1906
1912
|
|
|
1913
|
+
declare type BrowserContentBehavior = {
|
|
1914
|
+
behavior: 'browser';
|
|
1915
|
+
/**
|
|
1916
|
+
* Additional property that can be specified when setting the behavior to browser.
|
|
1917
|
+
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
|
1918
|
+
*/
|
|
1919
|
+
closeExisting?: boolean;
|
|
1920
|
+
};
|
|
1921
|
+
|
|
1907
1922
|
/**
|
|
1908
1923
|
* A rule prescribing content creation in the browser.
|
|
1909
1924
|
*
|
|
@@ -3720,6 +3735,15 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3720
3735
|
type: 'container-created';
|
|
3721
3736
|
};
|
|
3722
3737
|
|
|
3738
|
+
/**
|
|
3739
|
+
* Sets the behavior for when a Window or View navigates or redirects to a matching URL
|
|
3740
|
+
*
|
|
3741
|
+
* 'allow': The content url is allowed.
|
|
3742
|
+
* 'block': The content url is blocked.
|
|
3743
|
+
* 'browser': The content url is blocked and it is opened in the system's default web browser.
|
|
3744
|
+
*/
|
|
3745
|
+
declare type ContentBehavior = BaseContentBehavior | 'browser';
|
|
3746
|
+
|
|
3723
3747
|
/**
|
|
3724
3748
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3725
3749
|
* @interface
|
|
@@ -3807,12 +3831,9 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3807
3831
|
declare type ContentNavigation = NavigationRules;
|
|
3808
3832
|
|
|
3809
3833
|
/**
|
|
3810
|
-
*
|
|
3811
|
-
*
|
|
3812
|
-
* * 'allow': The content url is allowed.
|
|
3813
|
-
* * 'block': The content url is blocked.
|
|
3834
|
+
* Controls whether a content url is allowed or blocked for navigation in Windows and Views or redirection for Windows, Views and iframes.
|
|
3814
3835
|
*/
|
|
3815
|
-
declare type ContentPermission =
|
|
3836
|
+
declare type ContentPermission = ContentBehavior | StructuredContentBehavior | StructuredContentPermissions;
|
|
3816
3837
|
|
|
3817
3838
|
/**
|
|
3818
3839
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
@@ -9426,13 +9447,14 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
|
9426
9447
|
};
|
|
9427
9448
|
|
|
9428
9449
|
/**
|
|
9429
|
-
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
|
9450
|
+
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules or when blocked by a domain-based permission content rule.
|
|
9430
9451
|
* @interface
|
|
9431
9452
|
*/
|
|
9432
9453
|
declare type NavigationRejectedEvent = NamedEvent & {
|
|
9433
9454
|
type: 'navigation-rejected';
|
|
9434
9455
|
sourceName?: string;
|
|
9435
9456
|
url: string;
|
|
9457
|
+
contentRule?: OpenFin.ContentPermission | undefined;
|
|
9436
9458
|
};
|
|
9437
9459
|
|
|
9438
9460
|
/**
|
|
@@ -9794,6 +9816,12 @@ declare namespace OpenFin {
|
|
|
9794
9816
|
DomainSettings,
|
|
9795
9817
|
ApiInjection,
|
|
9796
9818
|
DomainApiSettings,
|
|
9819
|
+
BaseContentBehavior,
|
|
9820
|
+
ContentBehavior,
|
|
9821
|
+
BaseStructuredContentBehavior,
|
|
9822
|
+
BrowserContentBehavior,
|
|
9823
|
+
StructuredContentBehavior,
|
|
9824
|
+
StructuredContentPermissions,
|
|
9797
9825
|
ContentPermission,
|
|
9798
9826
|
PerDomainSettings,
|
|
9799
9827
|
DomainSettingsRule,
|
|
@@ -13735,6 +13763,29 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
13735
13763
|
type: 'started';
|
|
13736
13764
|
};
|
|
13737
13765
|
|
|
13766
|
+
/**
|
|
13767
|
+
* Allows more control over content behaviors
|
|
13768
|
+
*/
|
|
13769
|
+
declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
|
|
13770
|
+
|
|
13771
|
+
/**
|
|
13772
|
+
* Specify rules for specific actions.
|
|
13773
|
+
*/
|
|
13774
|
+
declare type StructuredContentPermissions = {
|
|
13775
|
+
/**
|
|
13776
|
+
* Controls the behavior for navigations
|
|
13777
|
+
*/
|
|
13778
|
+
navigate?: ContentBehavior | StructuredContentBehavior;
|
|
13779
|
+
/**
|
|
13780
|
+
* Controls the behavior for redirects
|
|
13781
|
+
*/
|
|
13782
|
+
redirect?: ContentBehavior | StructuredContentBehavior;
|
|
13783
|
+
/**
|
|
13784
|
+
* Controls the behavior for when iframes try to redirect
|
|
13785
|
+
*/
|
|
13786
|
+
iframe?: BaseContentBehavior;
|
|
13787
|
+
};
|
|
13788
|
+
|
|
13738
13789
|
/**
|
|
13739
13790
|
* @interface
|
|
13740
13791
|
*/
|
|
@@ -17244,7 +17295,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17244
17295
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17245
17296
|
* });
|
|
17246
17297
|
*
|
|
17247
|
-
* await view.navigate('
|
|
17298
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17248
17299
|
*
|
|
17249
17300
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17250
17301
|
* ```
|
|
@@ -17255,7 +17306,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17255
17306
|
* name:'child',
|
|
17256
17307
|
* defaultWidth: 300,
|
|
17257
17308
|
* defaultHeight: 300,
|
|
17258
|
-
* url: '
|
|
17309
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17259
17310
|
* frame: true,
|
|
17260
17311
|
* autoShow: true
|
|
17261
17312
|
* };
|
|
@@ -17280,7 +17331,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17280
17331
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17281
17332
|
* });
|
|
17282
17333
|
*
|
|
17283
|
-
* await view.navigate('
|
|
17334
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17284
17335
|
*
|
|
17285
17336
|
* await view.inspectSharedWorker();
|
|
17286
17337
|
* ```
|
|
@@ -17291,7 +17342,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17291
17342
|
* name:'child',
|
|
17292
17343
|
* defaultWidth: 300,
|
|
17293
17344
|
* defaultHeight: 300,
|
|
17294
|
-
* url: '
|
|
17345
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17295
17346
|
* frame: true,
|
|
17296
17347
|
* autoShow: true
|
|
17297
17348
|
* };
|
|
@@ -17317,7 +17368,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17317
17368
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17318
17369
|
* });
|
|
17319
17370
|
*
|
|
17320
|
-
* await view.navigate('
|
|
17371
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17321
17372
|
*
|
|
17322
17373
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17323
17374
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -17329,7 +17380,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17329
17380
|
* name:'child',
|
|
17330
17381
|
* defaultWidth: 300,
|
|
17331
17382
|
* defaultHeight: 300,
|
|
17332
|
-
* url: '
|
|
17383
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17333
17384
|
* frame: true,
|
|
17334
17385
|
* autoShow: true
|
|
17335
17386
|
* };
|
package/out/fdc3-api-public.d.ts
CHANGED
|
@@ -1661,6 +1661,8 @@ declare type BaseConfig = {
|
|
|
1661
1661
|
timeout?: number;
|
|
1662
1662
|
};
|
|
1663
1663
|
|
|
1664
|
+
declare type BaseContentBehavior = 'allow' | 'block';
|
|
1665
|
+
|
|
1664
1666
|
/**
|
|
1665
1667
|
* Properties shared by all content creation rules, regardless of context.
|
|
1666
1668
|
*
|
|
@@ -1804,6 +1806,10 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1804
1806
|
isMainFrame: boolean;
|
|
1805
1807
|
};
|
|
1806
1808
|
|
|
1809
|
+
declare type BaseStructuredContentBehavior = {
|
|
1810
|
+
behavior: BaseContentBehavior;
|
|
1811
|
+
};
|
|
1812
|
+
|
|
1807
1813
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1808
1814
|
type: 'url-changed';
|
|
1809
1815
|
url: string;
|
|
@@ -1904,6 +1910,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
|
1904
1910
|
|
|
1905
1911
|
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1906
1912
|
|
|
1913
|
+
declare type BrowserContentBehavior = {
|
|
1914
|
+
behavior: 'browser';
|
|
1915
|
+
/**
|
|
1916
|
+
* Additional property that can be specified when setting the behavior to browser.
|
|
1917
|
+
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
|
1918
|
+
*/
|
|
1919
|
+
closeExisting?: boolean;
|
|
1920
|
+
};
|
|
1921
|
+
|
|
1907
1922
|
/**
|
|
1908
1923
|
* A rule prescribing content creation in the browser.
|
|
1909
1924
|
*
|
|
@@ -3720,6 +3735,15 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3720
3735
|
type: 'container-created';
|
|
3721
3736
|
};
|
|
3722
3737
|
|
|
3738
|
+
/**
|
|
3739
|
+
* Sets the behavior for when a Window or View navigates or redirects to a matching URL
|
|
3740
|
+
*
|
|
3741
|
+
* 'allow': The content url is allowed.
|
|
3742
|
+
* 'block': The content url is blocked.
|
|
3743
|
+
* 'browser': The content url is blocked and it is opened in the system's default web browser.
|
|
3744
|
+
*/
|
|
3745
|
+
declare type ContentBehavior = BaseContentBehavior | 'browser';
|
|
3746
|
+
|
|
3723
3747
|
/**
|
|
3724
3748
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3725
3749
|
* @interface
|
|
@@ -3807,12 +3831,9 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3807
3831
|
declare type ContentNavigation = NavigationRules;
|
|
3808
3832
|
|
|
3809
3833
|
/**
|
|
3810
|
-
*
|
|
3811
|
-
*
|
|
3812
|
-
* * 'allow': The content url is allowed.
|
|
3813
|
-
* * 'block': The content url is blocked.
|
|
3834
|
+
* Controls whether a content url is allowed or blocked for navigation in Windows and Views or redirection for Windows, Views and iframes.
|
|
3814
3835
|
*/
|
|
3815
|
-
declare type ContentPermission =
|
|
3836
|
+
declare type ContentPermission = ContentBehavior | StructuredContentBehavior | StructuredContentPermissions;
|
|
3816
3837
|
|
|
3817
3838
|
/**
|
|
3818
3839
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
@@ -9426,13 +9447,14 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
|
9426
9447
|
};
|
|
9427
9448
|
|
|
9428
9449
|
/**
|
|
9429
|
-
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
|
9450
|
+
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules or when blocked by a domain-based permission content rule.
|
|
9430
9451
|
* @interface
|
|
9431
9452
|
*/
|
|
9432
9453
|
declare type NavigationRejectedEvent = NamedEvent & {
|
|
9433
9454
|
type: 'navigation-rejected';
|
|
9434
9455
|
sourceName?: string;
|
|
9435
9456
|
url: string;
|
|
9457
|
+
contentRule?: OpenFin.ContentPermission | undefined;
|
|
9436
9458
|
};
|
|
9437
9459
|
|
|
9438
9460
|
/**
|
|
@@ -9794,6 +9816,12 @@ declare namespace OpenFin {
|
|
|
9794
9816
|
DomainSettings,
|
|
9795
9817
|
ApiInjection,
|
|
9796
9818
|
DomainApiSettings,
|
|
9819
|
+
BaseContentBehavior,
|
|
9820
|
+
ContentBehavior,
|
|
9821
|
+
BaseStructuredContentBehavior,
|
|
9822
|
+
BrowserContentBehavior,
|
|
9823
|
+
StructuredContentBehavior,
|
|
9824
|
+
StructuredContentPermissions,
|
|
9797
9825
|
ContentPermission,
|
|
9798
9826
|
PerDomainSettings,
|
|
9799
9827
|
DomainSettingsRule,
|
|
@@ -13735,6 +13763,29 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
13735
13763
|
type: 'started';
|
|
13736
13764
|
};
|
|
13737
13765
|
|
|
13766
|
+
/**
|
|
13767
|
+
* Allows more control over content behaviors
|
|
13768
|
+
*/
|
|
13769
|
+
declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
|
|
13770
|
+
|
|
13771
|
+
/**
|
|
13772
|
+
* Specify rules for specific actions.
|
|
13773
|
+
*/
|
|
13774
|
+
declare type StructuredContentPermissions = {
|
|
13775
|
+
/**
|
|
13776
|
+
* Controls the behavior for navigations
|
|
13777
|
+
*/
|
|
13778
|
+
navigate?: ContentBehavior | StructuredContentBehavior;
|
|
13779
|
+
/**
|
|
13780
|
+
* Controls the behavior for redirects
|
|
13781
|
+
*/
|
|
13782
|
+
redirect?: ContentBehavior | StructuredContentBehavior;
|
|
13783
|
+
/**
|
|
13784
|
+
* Controls the behavior for when iframes try to redirect
|
|
13785
|
+
*/
|
|
13786
|
+
iframe?: BaseContentBehavior;
|
|
13787
|
+
};
|
|
13788
|
+
|
|
13738
13789
|
/**
|
|
13739
13790
|
* @interface
|
|
13740
13791
|
*/
|
|
@@ -17244,7 +17295,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17244
17295
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17245
17296
|
* });
|
|
17246
17297
|
*
|
|
17247
|
-
* await view.navigate('
|
|
17298
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17248
17299
|
*
|
|
17249
17300
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17250
17301
|
* ```
|
|
@@ -17255,7 +17306,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17255
17306
|
* name:'child',
|
|
17256
17307
|
* defaultWidth: 300,
|
|
17257
17308
|
* defaultHeight: 300,
|
|
17258
|
-
* url: '
|
|
17309
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17259
17310
|
* frame: true,
|
|
17260
17311
|
* autoShow: true
|
|
17261
17312
|
* };
|
|
@@ -17280,7 +17331,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17280
17331
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17281
17332
|
* });
|
|
17282
17333
|
*
|
|
17283
|
-
* await view.navigate('
|
|
17334
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17284
17335
|
*
|
|
17285
17336
|
* await view.inspectSharedWorker();
|
|
17286
17337
|
* ```
|
|
@@ -17291,7 +17342,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17291
17342
|
* name:'child',
|
|
17292
17343
|
* defaultWidth: 300,
|
|
17293
17344
|
* defaultHeight: 300,
|
|
17294
|
-
* url: '
|
|
17345
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17295
17346
|
* frame: true,
|
|
17296
17347
|
* autoShow: true
|
|
17297
17348
|
* };
|
|
@@ -17317,7 +17368,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17317
17368
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17318
17369
|
* });
|
|
17319
17370
|
*
|
|
17320
|
-
* await view.navigate('
|
|
17371
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17321
17372
|
*
|
|
17322
17373
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17323
17374
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -17329,7 +17380,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17329
17380
|
* name:'child',
|
|
17330
17381
|
* defaultWidth: 300,
|
|
17331
17382
|
* defaultHeight: 300,
|
|
17332
|
-
* url: '
|
|
17383
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17333
17384
|
* frame: true,
|
|
17334
17385
|
* autoShow: true
|
|
17335
17386
|
* };
|
package/out/fdc3-api.d.ts
CHANGED
|
@@ -1693,6 +1693,8 @@ declare type BaseConfig = {
|
|
|
1693
1693
|
timeout?: number;
|
|
1694
1694
|
};
|
|
1695
1695
|
|
|
1696
|
+
declare type BaseContentBehavior = 'allow' | 'block';
|
|
1697
|
+
|
|
1696
1698
|
/**
|
|
1697
1699
|
* Properties shared by all content creation rules, regardless of context.
|
|
1698
1700
|
*
|
|
@@ -1836,6 +1838,10 @@ declare type BaseLoadFailedEvent = NamedEvent & {
|
|
|
1836
1838
|
isMainFrame: boolean;
|
|
1837
1839
|
};
|
|
1838
1840
|
|
|
1841
|
+
declare type BaseStructuredContentBehavior = {
|
|
1842
|
+
behavior: BaseContentBehavior;
|
|
1843
|
+
};
|
|
1844
|
+
|
|
1839
1845
|
declare type BaseUrlEvent = NamedEvent & {
|
|
1840
1846
|
type: 'url-changed';
|
|
1841
1847
|
url: string;
|
|
@@ -1936,6 +1942,15 @@ declare type BoundsDidChangeEvent = BoundsChangeEvent & {
|
|
|
1936
1942
|
|
|
1937
1943
|
declare type BoundsEvent = BaseEvent_5 & OpenFin.Bounds;
|
|
1938
1944
|
|
|
1945
|
+
declare type BrowserContentBehavior = {
|
|
1946
|
+
behavior: 'browser';
|
|
1947
|
+
/**
|
|
1948
|
+
* Additional property that can be specified when setting the behavior to browser.
|
|
1949
|
+
* When set to true will close the Window or View that tried to navigate or redirect to the blocked URL.
|
|
1950
|
+
*/
|
|
1951
|
+
closeExisting?: boolean;
|
|
1952
|
+
};
|
|
1953
|
+
|
|
1939
1954
|
/**
|
|
1940
1955
|
* A rule prescribing content creation in the browser.
|
|
1941
1956
|
*
|
|
@@ -3779,6 +3794,15 @@ declare type ContainerCreatedEvent = LayoutDOMEvent & {
|
|
|
3779
3794
|
type: 'container-created';
|
|
3780
3795
|
};
|
|
3781
3796
|
|
|
3797
|
+
/**
|
|
3798
|
+
* Sets the behavior for when a Window or View navigates or redirects to a matching URL
|
|
3799
|
+
*
|
|
3800
|
+
* 'allow': The content url is allowed.
|
|
3801
|
+
* 'block': The content url is blocked.
|
|
3802
|
+
* 'browser': The content url is blocked and it is opened in the system's default web browser.
|
|
3803
|
+
*/
|
|
3804
|
+
declare type ContentBehavior = BaseContentBehavior | 'browser';
|
|
3805
|
+
|
|
3782
3806
|
/**
|
|
3783
3807
|
* Generated when content navigation or redirection is blocked by {@link OpenFin.DomainSettings}.
|
|
3784
3808
|
* @interface
|
|
@@ -3866,12 +3890,9 @@ declare type ContentCreationRulesEvent = NamedEvent & {
|
|
|
3866
3890
|
declare type ContentNavigation = NavigationRules;
|
|
3867
3891
|
|
|
3868
3892
|
/**
|
|
3869
|
-
*
|
|
3870
|
-
*
|
|
3871
|
-
* * 'allow': The content url is allowed.
|
|
3872
|
-
* * 'block': The content url is blocked.
|
|
3893
|
+
* Controls whether a content url is allowed or blocked for navigation in Windows and Views or redirection for Windows, Views and iframes.
|
|
3873
3894
|
*/
|
|
3874
|
-
declare type ContentPermission =
|
|
3895
|
+
declare type ContentPermission = ContentBehavior | StructuredContentBehavior | StructuredContentPermissions;
|
|
3875
3896
|
|
|
3876
3897
|
/**
|
|
3877
3898
|
* Restrict redirects to URLs that match an allowed pattern.
|
|
@@ -9734,13 +9755,14 @@ declare type NativeWindowIntegrationProviderAuthorization = {
|
|
|
9734
9755
|
};
|
|
9735
9756
|
|
|
9736
9757
|
/**
|
|
9737
|
-
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules.
|
|
9758
|
+
* Generated when view navigation is rejected as per contentNavigation allowlist/denylist rules or when blocked by a domain-based permission content rule.
|
|
9738
9759
|
* @interface
|
|
9739
9760
|
*/
|
|
9740
9761
|
declare type NavigationRejectedEvent = NamedEvent & {
|
|
9741
9762
|
type: 'navigation-rejected';
|
|
9742
9763
|
sourceName?: string;
|
|
9743
9764
|
url: string;
|
|
9765
|
+
contentRule?: OpenFin.ContentPermission | undefined;
|
|
9744
9766
|
};
|
|
9745
9767
|
|
|
9746
9768
|
/**
|
|
@@ -10112,6 +10134,12 @@ declare namespace OpenFin {
|
|
|
10112
10134
|
DomainSettings,
|
|
10113
10135
|
ApiInjection,
|
|
10114
10136
|
DomainApiSettings,
|
|
10137
|
+
BaseContentBehavior,
|
|
10138
|
+
ContentBehavior,
|
|
10139
|
+
BaseStructuredContentBehavior,
|
|
10140
|
+
BrowserContentBehavior,
|
|
10141
|
+
StructuredContentBehavior,
|
|
10142
|
+
StructuredContentPermissions,
|
|
10115
10143
|
ContentPermission,
|
|
10116
10144
|
PerDomainSettings,
|
|
10117
10145
|
DomainSettingsRule,
|
|
@@ -14139,6 +14167,29 @@ declare type StartedEvent = BaseEvents.IdentityEvent & {
|
|
|
14139
14167
|
type: 'started';
|
|
14140
14168
|
};
|
|
14141
14169
|
|
|
14170
|
+
/**
|
|
14171
|
+
* Allows more control over content behaviors
|
|
14172
|
+
*/
|
|
14173
|
+
declare type StructuredContentBehavior = BaseStructuredContentBehavior | BrowserContentBehavior;
|
|
14174
|
+
|
|
14175
|
+
/**
|
|
14176
|
+
* Specify rules for specific actions.
|
|
14177
|
+
*/
|
|
14178
|
+
declare type StructuredContentPermissions = {
|
|
14179
|
+
/**
|
|
14180
|
+
* Controls the behavior for navigations
|
|
14181
|
+
*/
|
|
14182
|
+
navigate?: ContentBehavior | StructuredContentBehavior;
|
|
14183
|
+
/**
|
|
14184
|
+
* Controls the behavior for redirects
|
|
14185
|
+
*/
|
|
14186
|
+
redirect?: ContentBehavior | StructuredContentBehavior;
|
|
14187
|
+
/**
|
|
14188
|
+
* Controls the behavior for when iframes try to redirect
|
|
14189
|
+
*/
|
|
14190
|
+
iframe?: BaseContentBehavior;
|
|
14191
|
+
};
|
|
14192
|
+
|
|
14142
14193
|
/**
|
|
14143
14194
|
* @interface
|
|
14144
14195
|
*/
|
|
@@ -17695,7 +17746,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17695
17746
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17696
17747
|
* });
|
|
17697
17748
|
*
|
|
17698
|
-
* await view.navigate('
|
|
17749
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17699
17750
|
*
|
|
17700
17751
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17701
17752
|
* ```
|
|
@@ -17706,7 +17757,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17706
17757
|
* name:'child',
|
|
17707
17758
|
* defaultWidth: 300,
|
|
17708
17759
|
* defaultHeight: 300,
|
|
17709
|
-
* url: '
|
|
17760
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17710
17761
|
* frame: true,
|
|
17711
17762
|
* autoShow: true
|
|
17712
17763
|
* };
|
|
@@ -17731,7 +17782,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17731
17782
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17732
17783
|
* });
|
|
17733
17784
|
*
|
|
17734
|
-
* await view.navigate('
|
|
17785
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17735
17786
|
*
|
|
17736
17787
|
* await view.inspectSharedWorker();
|
|
17737
17788
|
* ```
|
|
@@ -17742,7 +17793,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17742
17793
|
* name:'child',
|
|
17743
17794
|
* defaultWidth: 300,
|
|
17744
17795
|
* defaultHeight: 300,
|
|
17745
|
-
* url: '
|
|
17796
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17746
17797
|
* frame: true,
|
|
17747
17798
|
* autoShow: true
|
|
17748
17799
|
* };
|
|
@@ -17768,7 +17819,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17768
17819
|
* bounds: {top: 10, left: 10, width: 200, height: 200}
|
|
17769
17820
|
* });
|
|
17770
17821
|
*
|
|
17771
|
-
* await view.navigate('
|
|
17822
|
+
* await view.navigate('https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/');
|
|
17772
17823
|
*
|
|
17773
17824
|
* const sharedWorkers = await view.getSharedWorkers();
|
|
17774
17825
|
* await view.inspectSharedWorkerById(sharedWorkers[0].id);
|
|
@@ -17780,7 +17831,7 @@ declare class WebContents<T extends BaseEvent> extends EmitterBase<T> {
|
|
|
17780
17831
|
* name:'child',
|
|
17781
17832
|
* defaultWidth: 300,
|
|
17782
17833
|
* defaultHeight: 300,
|
|
17783
|
-
* url: '
|
|
17834
|
+
* url: 'https://mdn.github.io/dom-examples/web-workers/simple-shared-worker/',
|
|
17784
17835
|
* frame: true,
|
|
17785
17836
|
* autoShow: true
|
|
17786
17837
|
* };
|