@openfin/fdc3-api 40.100.6 → 40.101.1

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.
@@ -189,6 +189,10 @@ declare type AppAssetRequest = {
189
189
  alias: string;
190
190
  };
191
191
 
192
+ declare type AppAssetServeRequest = ServeRequest & {
193
+ alias: string;
194
+ };
195
+
192
196
  /**
193
197
  * An object representing an application. Allows the developer to create,
194
198
  * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
@@ -3407,6 +3411,13 @@ declare type ConstViewOptions = {
3407
3411
  * The identity of the window this view should be attached to.
3408
3412
  */
3409
3413
  target: Identity_4;
3414
+ /**
3415
+ * Defaults to `name`.
3416
+ * Ignored in container, but used in @openfin/core-web to set tab titles.
3417
+ * Order of precedence for title in container is: document.title, viewOptions.url.
3418
+ * Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
3419
+ */
3420
+ title: string;
3410
3421
  /**
3411
3422
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3412
3423
  */
@@ -4386,6 +4397,10 @@ declare type DomainApiSettings = {
4386
4397
  *
4387
4398
  * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4388
4399
  * domain should be represented with a single rule.
4400
+ *
4401
+ * Renderers opened on `about:blank` are considered to belong to the domain of their opener (or, in the case of iframes,
4402
+ * their parent), effective recursively. Domain rules matched to `about:blank` will only apply in cases where no opener
4403
+ * exists.
4389
4404
  */
4390
4405
  declare type DomainSettings = {
4391
4406
  /**
@@ -9948,6 +9963,11 @@ declare namespace OpenFin {
9948
9963
  DownloadShelfOptions,
9949
9964
  ViewShowAtOptions,
9950
9965
  ExtensionInfo,
9966
+ ServeRequest,
9967
+ AppAssetServeRequest,
9968
+ PathServeRequest,
9969
+ ServeAssetOptions,
9970
+ ServedAssetInfo,
9951
9971
  ApplicationEvents,
9952
9972
  BaseEvents,
9953
9973
  ExternalApplicationEvents,
@@ -10014,6 +10034,10 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
10014
10034
  title: string;
10015
10035
  };
10016
10036
 
10037
+ declare type PathServeRequest = ServeRequest & {
10038
+ path: string;
10039
+ };
10040
+
10017
10041
  declare type Payload<Success extends boolean = boolean, Data = any> = {
10018
10042
  success: Success;
10019
10043
  data: Success extends true ? Data : never;
@@ -12633,6 +12657,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
12633
12657
  options: OpenFin.ProcessLoggingOptions;
12634
12658
  }, void>;
12635
12659
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
12660
+ 'serve-asset': ApiCall<{
12661
+ options: OpenFin.ServeAssetOptions;
12662
+ }, OpenFin.ServedAssetInfo>;
12636
12663
  'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
12637
12664
  domainSettings: OpenFin.DefaultDomainSettings;
12638
12665
  }, void>;
@@ -13365,6 +13392,16 @@ declare type SentMessage<Value> = Promise<Value> & {
13365
13392
  messageId: ReturnType<Environment['getNextMessageId']>;
13366
13393
  };
13367
13394
 
13395
+ declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
13396
+
13397
+ declare type ServedAssetInfo = {
13398
+ baseUrl: string;
13399
+ };
13400
+
13401
+ declare type ServeRequest = {
13402
+ hostName: string;
13403
+ };
13404
+
13368
13405
  /**
13369
13406
  * @interface
13370
13407
  */
@@ -15286,6 +15323,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15286
15323
  * Gets the currently-installed
15287
15324
  */
15288
15325
  getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15326
+ /**
15327
+ * Used to serve an asset signed by OpenFin within the given runtime.
15328
+ * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
15329
+ */
15330
+ serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
15289
15331
  }
15290
15332
 
15291
15333
  /**
@@ -189,6 +189,10 @@ declare type AppAssetRequest = {
189
189
  alias: string;
190
190
  };
191
191
 
192
+ declare type AppAssetServeRequest = ServeRequest & {
193
+ alias: string;
194
+ };
195
+
192
196
  /**
193
197
  * An object representing an application. Allows the developer to create,
194
198
  * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
@@ -3407,6 +3411,13 @@ declare type ConstViewOptions = {
3407
3411
  * The identity of the window this view should be attached to.
3408
3412
  */
3409
3413
  target: Identity_4;
3414
+ /**
3415
+ * Defaults to `name`.
3416
+ * Ignored in container, but used in @openfin/core-web to set tab titles.
3417
+ * Order of precedence for title in container is: document.title, viewOptions.url.
3418
+ * Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
3419
+ */
3420
+ title: string;
3410
3421
  /**
3411
3422
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3412
3423
  */
@@ -4386,6 +4397,10 @@ declare type DomainApiSettings = {
4386
4397
  *
4387
4398
  * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4388
4399
  * domain should be represented with a single rule.
4400
+ *
4401
+ * Renderers opened on `about:blank` are considered to belong to the domain of their opener (or, in the case of iframes,
4402
+ * their parent), effective recursively. Domain rules matched to `about:blank` will only apply in cases where no opener
4403
+ * exists.
4389
4404
  */
4390
4405
  declare type DomainSettings = {
4391
4406
  /**
@@ -9948,6 +9963,11 @@ declare namespace OpenFin {
9948
9963
  DownloadShelfOptions,
9949
9964
  ViewShowAtOptions,
9950
9965
  ExtensionInfo,
9966
+ ServeRequest,
9967
+ AppAssetServeRequest,
9968
+ PathServeRequest,
9969
+ ServeAssetOptions,
9970
+ ServedAssetInfo,
9951
9971
  ApplicationEvents,
9952
9972
  BaseEvents,
9953
9973
  ExternalApplicationEvents,
@@ -10014,6 +10034,10 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
10014
10034
  title: string;
10015
10035
  };
10016
10036
 
10037
+ declare type PathServeRequest = ServeRequest & {
10038
+ path: string;
10039
+ };
10040
+
10017
10041
  declare type Payload<Success extends boolean = boolean, Data = any> = {
10018
10042
  success: Success;
10019
10043
  data: Success extends true ? Data : never;
@@ -12633,6 +12657,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
12633
12657
  options: OpenFin.ProcessLoggingOptions;
12634
12658
  }, void>;
12635
12659
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
12660
+ 'serve-asset': ApiCall<{
12661
+ options: OpenFin.ServeAssetOptions;
12662
+ }, OpenFin.ServedAssetInfo>;
12636
12663
  'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
12637
12664
  domainSettings: OpenFin.DefaultDomainSettings;
12638
12665
  }, void>;
@@ -13365,6 +13392,16 @@ declare type SentMessage<Value> = Promise<Value> & {
13365
13392
  messageId: ReturnType<Environment['getNextMessageId']>;
13366
13393
  };
13367
13394
 
13395
+ declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
13396
+
13397
+ declare type ServedAssetInfo = {
13398
+ baseUrl: string;
13399
+ };
13400
+
13401
+ declare type ServeRequest = {
13402
+ hostName: string;
13403
+ };
13404
+
13368
13405
  /**
13369
13406
  * @interface
13370
13407
  */
@@ -15286,6 +15323,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15286
15323
  * Gets the currently-installed
15287
15324
  */
15288
15325
  getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15326
+ /**
15327
+ * Used to serve an asset signed by OpenFin within the given runtime.
15328
+ * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
15329
+ */
15330
+ serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
15289
15331
  }
15290
15332
 
15291
15333
  /**
@@ -189,6 +189,10 @@ declare type AppAssetRequest = {
189
189
  alias: string;
190
190
  };
191
191
 
192
+ declare type AppAssetServeRequest = ServeRequest & {
193
+ alias: string;
194
+ };
195
+
192
196
  /**
193
197
  * An object representing an application. Allows the developer to create,
194
198
  * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
@@ -3407,6 +3411,13 @@ declare type ConstViewOptions = {
3407
3411
  * The identity of the window this view should be attached to.
3408
3412
  */
3409
3413
  target: Identity_4;
3414
+ /**
3415
+ * Defaults to `name`.
3416
+ * Ignored in container, but used in @openfin/core-web to set tab titles.
3417
+ * Order of precedence for title in container is: document.title, viewOptions.url.
3418
+ * Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
3419
+ */
3420
+ title: string;
3410
3421
  /**
3411
3422
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3412
3423
  */
@@ -4386,6 +4397,10 @@ declare type DomainApiSettings = {
4386
4397
  *
4387
4398
  * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4388
4399
  * domain should be represented with a single rule.
4400
+ *
4401
+ * Renderers opened on `about:blank` are considered to belong to the domain of their opener (or, in the case of iframes,
4402
+ * their parent), effective recursively. Domain rules matched to `about:blank` will only apply in cases where no opener
4403
+ * exists.
4389
4404
  */
4390
4405
  declare type DomainSettings = {
4391
4406
  /**
@@ -9948,6 +9963,11 @@ declare namespace OpenFin {
9948
9963
  DownloadShelfOptions,
9949
9964
  ViewShowAtOptions,
9950
9965
  ExtensionInfo,
9966
+ ServeRequest,
9967
+ AppAssetServeRequest,
9968
+ PathServeRequest,
9969
+ ServeAssetOptions,
9970
+ ServedAssetInfo,
9951
9971
  ApplicationEvents,
9952
9972
  BaseEvents,
9953
9973
  ExternalApplicationEvents,
@@ -10014,6 +10034,10 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
10014
10034
  title: string;
10015
10035
  };
10016
10036
 
10037
+ declare type PathServeRequest = ServeRequest & {
10038
+ path: string;
10039
+ };
10040
+
10017
10041
  declare type Payload<Success extends boolean = boolean, Data = any> = {
10018
10042
  success: Success;
10019
10043
  data: Success extends true ? Data : never;
@@ -12633,6 +12657,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
12633
12657
  options: OpenFin.ProcessLoggingOptions;
12634
12658
  }, void>;
12635
12659
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
12660
+ 'serve-asset': ApiCall<{
12661
+ options: OpenFin.ServeAssetOptions;
12662
+ }, OpenFin.ServedAssetInfo>;
12636
12663
  'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
12637
12664
  domainSettings: OpenFin.DefaultDomainSettings;
12638
12665
  }, void>;
@@ -13365,6 +13392,16 @@ declare type SentMessage<Value> = Promise<Value> & {
13365
13392
  messageId: ReturnType<Environment['getNextMessageId']>;
13366
13393
  };
13367
13394
 
13395
+ declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
13396
+
13397
+ declare type ServedAssetInfo = {
13398
+ baseUrl: string;
13399
+ };
13400
+
13401
+ declare type ServeRequest = {
13402
+ hostName: string;
13403
+ };
13404
+
13368
13405
  /**
13369
13406
  * @interface
13370
13407
  */
@@ -15286,6 +15323,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15286
15323
  * Gets the currently-installed
15287
15324
  */
15288
15325
  getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15326
+ /**
15327
+ * Used to serve an asset signed by OpenFin within the given runtime.
15328
+ * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
15329
+ */
15330
+ serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
15289
15331
  }
15290
15332
 
15291
15333
  /**
package/out/fdc3-api.d.ts CHANGED
@@ -189,6 +189,10 @@ declare type AppAssetRequest = {
189
189
  alias: string;
190
190
  };
191
191
 
192
+ declare type AppAssetServeRequest = ServeRequest & {
193
+ alias: string;
194
+ };
195
+
192
196
  /**
193
197
  * An object representing an application. Allows the developer to create,
194
198
  * execute, show/close an application as well as listen to {@link OpenFin.ApplicationEvents application events}.
@@ -3466,6 +3470,13 @@ declare type ConstViewOptions = {
3466
3470
  * The identity of the window this view should be attached to.
3467
3471
  */
3468
3472
  target: Identity_4;
3473
+ /**
3474
+ * Defaults to `name`.
3475
+ * Ignored in container, but used in @openfin/core-web to set tab titles.
3476
+ * Order of precedence for title in container is: document.title, viewOptions.url.
3477
+ * Order of precedence for title in @openfin/core-web is ComponentConfig.title, viewOptions.title, viewOptions.url.
3478
+ */
3479
+ title: string;
3469
3480
  /**
3470
3481
  * Configures how new content (e,g, from `window.open` or a link) is opened.
3471
3482
  */
@@ -4445,6 +4456,10 @@ declare type DomainApiSettings = {
4445
4456
  *
4446
4457
  * @remarks Only the first rule in the array that matches the current URL is applied. Multiple behaviors for the same
4447
4458
  * domain should be represented with a single rule.
4459
+ *
4460
+ * Renderers opened on `about:blank` are considered to belong to the domain of their opener (or, in the case of iframes,
4461
+ * their parent), effective recursively. Domain rules matched to `about:blank` will only apply in cases where no opener
4462
+ * exists.
4448
4463
  */
4449
4464
  declare type DomainSettings = {
4450
4465
  /**
@@ -10266,6 +10281,11 @@ declare namespace OpenFin {
10266
10281
  DownloadShelfOptions,
10267
10282
  ViewShowAtOptions,
10268
10283
  ExtensionInfo,
10284
+ ServeRequest,
10285
+ AppAssetServeRequest,
10286
+ PathServeRequest,
10287
+ ServeAssetOptions,
10288
+ ServedAssetInfo,
10269
10289
  ApplicationEvents,
10270
10290
  BaseEvents,
10271
10291
  ExternalApplicationEvents,
@@ -10332,6 +10352,10 @@ declare type PageTitleUpdatedEvent = NamedEvent & {
10332
10352
  title: string;
10333
10353
  };
10334
10354
 
10355
+ declare type PathServeRequest = ServeRequest & {
10356
+ path: string;
10357
+ };
10358
+
10335
10359
  declare type Payload<Success extends boolean = boolean, Data = any> = {
10336
10360
  success: Success;
10337
10361
  data: Success extends true ? Data : never;
@@ -13034,6 +13058,9 @@ declare interface ProtocolMap extends ProtocolMapBase {
13034
13058
  options: OpenFin.ProcessLoggingOptions;
13035
13059
  }, void>;
13036
13060
  'get-domain-settings': ApiCall<OpenFin.ApplicationIdentity, OpenFin.DefaultDomainSettings>;
13061
+ 'serve-asset': ApiCall<{
13062
+ options: OpenFin.ServeAssetOptions;
13063
+ }, OpenFin.ServedAssetInfo>;
13037
13064
  'set-domain-settings': ApiCall<OpenFin.ApplicationIdentity & {
13038
13065
  domainSettings: OpenFin.DefaultDomainSettings;
13039
13066
  }, void>;
@@ -13766,6 +13793,16 @@ declare type SentMessage<Value> = Promise<Value> & {
13766
13793
  messageId: ReturnType<Environment['getNextMessageId']>;
13767
13794
  };
13768
13795
 
13796
+ declare type ServeAssetOptions = AppAssetServeRequest | PathServeRequest;
13797
+
13798
+ declare type ServedAssetInfo = {
13799
+ baseUrl: string;
13800
+ };
13801
+
13802
+ declare type ServeRequest = {
13803
+ hostName: string;
13804
+ };
13805
+
13769
13806
  /**
13770
13807
  * @interface
13771
13808
  */
@@ -15693,6 +15730,11 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
15693
15730
  * Gets the currently-installed
15694
15731
  */
15695
15732
  getInstalledExtensions(): Promise<OpenFin.ExtensionInfo[]>;
15733
+ /**
15734
+ * Used to serve an asset signed by OpenFin within the given runtime.
15735
+ * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
15736
+ */
15737
+ serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
15696
15738
  }
15697
15739
 
15698
15740
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "40.100.6",
3
+ "version": "40.101.1",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "private": false,