@openfin/fdc3-api 39.81.14 → 39.81.17

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.
@@ -1164,9 +1164,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1164
1164
  * The name of the application.
1165
1165
  *
1166
1166
  * @remarks
1167
- * This property is only used for naming the application logging folder, which will be sanitized to remove
1168
- * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1169
- * during startup with the UUID of the application.
1167
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1168
+ * any special characters, spaces or international characters. It's also used in error messages, API
1169
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1170
1170
  *
1171
1171
  * This property will be deprecated in the future.
1172
1172
  */
@@ -4639,6 +4639,12 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4639
4639
  } : never;
4640
4640
 
4641
4641
  declare interface Environment {
4642
+ /**
4643
+ * Returns the version of the adapter synchronously.
4644
+ * In OpenFin, this is the version of the runtime.
4645
+ * Elsewhere (e.g. Node.js), this is the version of the adapter, NOT the runtime.
4646
+ */
4647
+ getAdapterVersionSync(): string;
4642
4648
  layoutAllowedInContext(fin: OpenFin.Fin<OpenFin.EntityType>): boolean;
4643
4649
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
4644
4650
  applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
@@ -1164,9 +1164,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1164
1164
  * The name of the application.
1165
1165
  *
1166
1166
  * @remarks
1167
- * This property is only used for naming the application logging folder, which will be sanitized to remove
1168
- * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1169
- * during startup with the UUID of the application.
1167
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1168
+ * any special characters, spaces or international characters. It's also used in error messages, API
1169
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1170
1170
  *
1171
1171
  * This property will be deprecated in the future.
1172
1172
  */
@@ -4639,6 +4639,12 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4639
4639
  } : never;
4640
4640
 
4641
4641
  declare interface Environment {
4642
+ /**
4643
+ * Returns the version of the adapter synchronously.
4644
+ * In OpenFin, this is the version of the runtime.
4645
+ * Elsewhere (e.g. Node.js), this is the version of the adapter, NOT the runtime.
4646
+ */
4647
+ getAdapterVersionSync(): string;
4642
4648
  layoutAllowedInContext(fin: OpenFin.Fin<OpenFin.EntityType>): boolean;
4643
4649
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
4644
4650
  applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
@@ -1164,9 +1164,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1164
1164
  * The name of the application.
1165
1165
  *
1166
1166
  * @remarks
1167
- * This property is only used for naming the application logging folder, which will be sanitized to remove
1168
- * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1169
- * during startup with the UUID of the application.
1167
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1168
+ * any special characters, spaces or international characters. It's also used in error messages, API
1169
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1170
1170
  *
1171
1171
  * This property will be deprecated in the future.
1172
1172
  */
@@ -4639,6 +4639,12 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4639
4639
  } : never;
4640
4640
 
4641
4641
  declare interface Environment {
4642
+ /**
4643
+ * Returns the version of the adapter synchronously.
4644
+ * In OpenFin, this is the version of the runtime.
4645
+ * Elsewhere (e.g. Node.js), this is the version of the adapter, NOT the runtime.
4646
+ */
4647
+ getAdapterVersionSync(): string;
4642
4648
  layoutAllowedInContext(fin: OpenFin.Fin<OpenFin.EntityType>): boolean;
4643
4649
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
4644
4650
  applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
package/out/fdc3-api.d.ts CHANGED
@@ -1170,9 +1170,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1170
1170
  * The name of the application.
1171
1171
  *
1172
1172
  * @remarks
1173
- * This property is only used for naming the application logging folder, which will be sanitized to remove
1174
- * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1175
- * during startup with the UUID of the application.
1173
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1174
+ * any special characters, spaces or international characters. It's also used in error messages, API
1175
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1176
1176
  *
1177
1177
  * This property will be deprecated in the future.
1178
1178
  */
@@ -4703,6 +4703,12 @@ declare type EntityTypeHelpers<T extends EntityType_2> = T extends 'view' ? {
4703
4703
  } : never;
4704
4704
 
4705
4705
  declare interface Environment {
4706
+ /**
4707
+ * Returns the version of the adapter synchronously.
4708
+ * In OpenFin, this is the version of the runtime.
4709
+ * Elsewhere (e.g. Node.js), this is the version of the adapter, NOT the runtime.
4710
+ */
4711
+ getAdapterVersionSync(): string;
4706
4712
  layoutAllowedInContext(fin: OpenFin.Fin<OpenFin.EntityType>): boolean;
4707
4713
  initLayoutManager(fin: OpenFin.Fin<OpenFin.EntityType>, wire: Transport, options: OpenFin.InitLayoutOptions): Promise<OpenFin.LayoutManager<OpenFin.LayoutSnapshot>>;
4708
4714
  applyLayoutSnapshot(fin: OpenFin.Fin<OpenFin.EntityType>, layoutManager: OpenFin.LayoutManager<OpenFin.LayoutSnapshot>, options: OpenFin.InitLayoutOptions): Promise<void>;
package/out/fdc3-api.js CHANGED
@@ -2194,14 +2194,11 @@ function requireFdc31_2 () {
2194
2194
  this.wire.sendAction('fdc3-get-info').catch((e) => {
2195
2195
  // we do not want to expose this error, just continue if this analytics-only call fails
2196
2196
  });
2197
- // @ts-expect-error
2198
- const { uuid, fdc3InteropApi } = fin.__internal_.initialOptions;
2199
- // @ts-expect-error
2200
- const runtimeVersion = fin.desktop.getVersion();
2197
+ const version = this.wire.environment.getAdapterVersionSync();
2201
2198
  return {
2202
- fdc3Version: fdc3InteropApi,
2203
- provider: `openfin-${uuid}`,
2204
- providerVersion: runtimeVersion
2199
+ providerVersion: version,
2200
+ provider: `openfin-${this.wire.me.uuid}`,
2201
+ fdc3Version: '1.2'
2205
2202
  };
2206
2203
  }
2207
2204
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/fdc3-api",
3
- "version": "39.81.14",
3
+ "version": "39.81.17",
4
4
  "description": "OpenFin fdc3 module utilities and types.",
5
5
  "license": "SEE LICENSE IN LICENSE.MD",
6
6
  "private": false,