@openfin/core 39.81.15 → 39.81.18

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.
@@ -1167,9 +1167,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1167
1167
  * The name of the application.
1168
1168
  *
1169
1169
  * @remarks
1170
- * This property is only used for naming the application logging folder, which will be sanitized to remove
1171
- * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1172
- * during startup with the UUID of the application.
1170
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1171
+ * any special characters, spaces or international characters. It's also used in error messages, API
1172
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1173
1173
  *
1174
1174
  * This property will be deprecated in the future.
1175
1175
  */
@@ -1602,11 +1602,8 @@ declare class Base {
1602
1602
  /* Excluded from this release type: __constructor */
1603
1603
  protected get fin(): OpenFin_2.Fin<OpenFin_2.EntityType>;
1604
1604
  /**
1605
- * Provides access to the OpenFin representation of the current code context (usually a document
1606
- * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
1607
- *
1608
- * Useful for debugging in the devtools console, where this will intelligently type itself based
1609
- * on the context in which the devtools panel was opened.
1605
+ * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
1606
+ * guaranteed to behave sensibly in all calling contexts.
1610
1607
  */
1611
1608
  get me(): Identity;
1612
1609
  /* Excluded from this release type: isNodeEnvironment */
@@ -5200,6 +5197,13 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5200
5197
  readonly Platform: PlatformModule;
5201
5198
  readonly Interop: InteropModule;
5202
5199
  readonly SnapshotSource: SnapshotSourceModule;
5200
+ /**
5201
+ * Provides access to the OpenFin representation of the current code context (usually an entity
5202
+ * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
5203
+ *
5204
+ * Useful for debugging in the devtools console, where this will intelligently type itself based
5205
+ * on the context in which the devtools panel was opened.
5206
+ */
5203
5207
  readonly me: Me<MeType>;
5204
5208
  }
5205
5209
 
@@ -1167,9 +1167,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1167
1167
  * The name of the application.
1168
1168
  *
1169
1169
  * @remarks
1170
- * This property is only used for naming the application logging folder, which will be sanitized to remove
1171
- * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1172
- * during startup with the UUID of the application.
1170
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1171
+ * any special characters, spaces or international characters. It's also used in error messages, API
1172
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1173
1173
  *
1174
1174
  * This property will be deprecated in the future.
1175
1175
  */
@@ -1602,11 +1602,8 @@ declare class Base {
1602
1602
  /* Excluded from this release type: __constructor */
1603
1603
  protected get fin(): OpenFin_2.Fin<OpenFin_2.EntityType>;
1604
1604
  /**
1605
- * Provides access to the OpenFin representation of the current code context (usually a document
1606
- * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
1607
- *
1608
- * Useful for debugging in the devtools console, where this will intelligently type itself based
1609
- * on the context in which the devtools panel was opened.
1605
+ * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
1606
+ * guaranteed to behave sensibly in all calling contexts.
1610
1607
  */
1611
1608
  get me(): Identity;
1612
1609
  /* Excluded from this release type: isNodeEnvironment */
@@ -5200,6 +5197,13 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5200
5197
  readonly Platform: PlatformModule;
5201
5198
  readonly Interop: InteropModule;
5202
5199
  readonly SnapshotSource: SnapshotSourceModule;
5200
+ /**
5201
+ * Provides access to the OpenFin representation of the current code context (usually an entity
5202
+ * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
5203
+ *
5204
+ * Useful for debugging in the devtools console, where this will intelligently type itself based
5205
+ * on the context in which the devtools panel was opened.
5206
+ */
5203
5207
  readonly me: Me<MeType>;
5204
5208
  }
5205
5209
 
@@ -1167,9 +1167,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1167
1167
  * The name of the application.
1168
1168
  *
1169
1169
  * @remarks
1170
- * This property is only used for naming the application logging folder, which will be sanitized to remove
1171
- * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1172
- * during startup with the UUID of the application.
1170
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1171
+ * any special characters, spaces or international characters. It's also used in error messages, API
1172
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1173
1173
  *
1174
1174
  * This property will be deprecated in the future.
1175
1175
  */
@@ -1602,11 +1602,8 @@ declare class Base {
1602
1602
  /* Excluded from this release type: __constructor */
1603
1603
  protected get fin(): OpenFin_2.Fin<OpenFin_2.EntityType>;
1604
1604
  /**
1605
- * Provides access to the OpenFin representation of the current code context (usually a document
1606
- * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
1607
- *
1608
- * Useful for debugging in the devtools console, where this will intelligently type itself based
1609
- * on the context in which the devtools panel was opened.
1605
+ * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
1606
+ * guaranteed to behave sensibly in all calling contexts.
1610
1607
  */
1611
1608
  get me(): Identity;
1612
1609
  /* Excluded from this release type: isNodeEnvironment */
@@ -5200,6 +5197,13 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5200
5197
  readonly Platform: PlatformModule;
5201
5198
  readonly Interop: InteropModule;
5202
5199
  readonly SnapshotSource: SnapshotSourceModule;
5200
+ /**
5201
+ * Provides access to the OpenFin representation of the current code context (usually an entity
5202
+ * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
5203
+ *
5204
+ * Useful for debugging in the devtools console, where this will intelligently type itself based
5205
+ * on the context in which the devtools panel was opened.
5206
+ */
5203
5207
  readonly me: Me<MeType>;
5204
5208
  }
5205
5209
 
package/out/mock.d.ts CHANGED
@@ -1173,9 +1173,9 @@ declare type ApplicationOptions = LegacyWinOptionsInAppOptions & {
1173
1173
  * The name of the application.
1174
1174
  *
1175
1175
  * @remarks
1176
- * This property is only used for naming the application logging folder, which will be sanitized to remove
1177
- * any special characters, spaces or international characters. Otherwise it's not used and it will be overwritten
1178
- * during startup with the UUID of the application.
1176
+ * This property is used for naming the application logging folder, which will be sanitized to remove
1177
+ * any special characters, spaces or international characters. It's also used in error messages, API
1178
+ * security dialog boxes and in the directory name in %localappdata%/OpenFin/apps/<name><hash>.
1179
1179
  *
1180
1180
  * This property will be deprecated in the future.
1181
1181
  */
@@ -1622,11 +1622,8 @@ declare class Base {
1622
1622
  constructor(wire: Transport);
1623
1623
  protected get fin(): OpenFin_2.Fin<OpenFin_2.EntityType>;
1624
1624
  /**
1625
- * Provides access to the OpenFin representation of the current code context (usually a document
1626
- * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
1627
- *
1628
- * Useful for debugging in the devtools console, where this will intelligently type itself based
1629
- * on the context in which the devtools panel was opened.
1625
+ * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
1626
+ * guaranteed to behave sensibly in all calling contexts.
1630
1627
  */
1631
1628
  get me(): Identity;
1632
1629
  /**
@@ -5285,6 +5282,13 @@ declare interface FinApi<MeType extends OpenFin_2.EntityType> {
5285
5282
  readonly Platform: PlatformModule;
5286
5283
  readonly Interop: InteropModule;
5287
5284
  readonly SnapshotSource: SnapshotSourceModule;
5285
+ /**
5286
+ * Provides access to the OpenFin representation of the current code context (usually an entity
5287
+ * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
5288
+ *
5289
+ * Useful for debugging in the devtools console, where this will intelligently type itself based
5290
+ * on the context in which the devtools panel was opened.
5291
+ */
5288
5292
  readonly me: Me<MeType>;
5289
5293
  }
5290
5294
 
package/out/mock.js CHANGED
@@ -370,11 +370,8 @@ class Base {
370
370
  return this.wire.getFin();
371
371
  }
372
372
  /**
373
- * Provides access to the OpenFin representation of the current code context (usually a document
374
- * such as a {@link OpenFin.View} or {@link OpenFin.Window}), as well as to the current `Interop` context.
375
- *
376
- * Useful for debugging in the devtools console, where this will intelligently type itself based
377
- * on the context in which the devtools panel was opened.
373
+ * @deprecated `me` should only be accessed from the `fin` global ({@link FinApi.me}); access through entity classes is not
374
+ * guaranteed to behave sensibly in all calling contexts.
378
375
  */
379
376
  get me() {
380
377
  return this.wire.me;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfin/core",
3
- "version": "39.81.15",
3
+ "version": "39.81.18",
4
4
  "description": "The core renderer entry point of OpenFin",
5
5
  "license": "SEE LICENSE IN LICENSE.md",
6
6
  "main": "out/mock.js",