@openfin/fdc3-api 38.81.34 → 38.81.37

package/out/fdc3-api-alpha.d.ts

@@ -5344,6 +5344,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
      * @tutorial fdc3.open
      */
     protected _open(app: v1_2.TargetApp, context?: v1_2.Context): Promise<v2_0.AppIdentifier>;
+    protected _getChannels(): Promise<ChannelType[]>;
     /**
      * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
      * @param channelId
@@ -5960,6 +5961,13 @@ declare type GpuInfo = {
 
 /**
  * Generated when a View is hidden.
+ *
+ * @remarks
+ * An OpenFin View's `hidden` event is only emitted when a specific View API is called.
+ * This event can fire when calling:
+ *
+ * * `view.hide()` - If a View is previously shown, a `hidden` event will be fired.
+ *
  * @interface
  */
 declare type HiddenEvent = BaseEvent_4 & {
@@ -12565,7 +12573,18 @@ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
 };
 
 /**
- * Generated when a View is shown. This event will fire during creation of a View.
+ * Generated when a View is shown.
+ *
+ * @remarks
+ * An OpenFin View's `shown` event is only emitted when specific View APIs are called.
+ * This event can fire when calling:
+ *
+ * * `view.show()` or `view.showAt()` - If a View is previously hidden, a `shown` event will be fired.
+ *
+ * * `view.attach()` - If a View is hidden and attached to a new Window, it will be shown and the `shown` event will be fired.
+ *
+ * * `view.create()` - A View `shown` event will be fired. (Internally the `attach` method is called when calling the `create` method, which fires the `shown` event.)
+ *
  * @interface
  */
 declare type ShownEvent = BaseEvent_4 & {

package/out/fdc3-api-beta.d.ts

@@ -5344,6 +5344,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
      * @tutorial fdc3.open
      */
     protected _open(app: v1_2.TargetApp, context?: v1_2.Context): Promise<v2_0.AppIdentifier>;
+    protected _getChannels(): Promise<ChannelType[]>;
     /**
      * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
      * @param channelId
@@ -5960,6 +5961,13 @@ declare type GpuInfo = {
 
 /**
  * Generated when a View is hidden.
+ *
+ * @remarks
+ * An OpenFin View's `hidden` event is only emitted when a specific View API is called.
+ * This event can fire when calling:
+ *
+ * * `view.hide()` - If a View is previously shown, a `hidden` event will be fired.
+ *
  * @interface
  */
 declare type HiddenEvent = BaseEvent_4 & {
@@ -12565,7 +12573,18 @@ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
 };
 
 /**
- * Generated when a View is shown. This event will fire during creation of a View.
+ * Generated when a View is shown.
+ *
+ * @remarks
+ * An OpenFin View's `shown` event is only emitted when specific View APIs are called.
+ * This event can fire when calling:
+ *
+ * * `view.show()` or `view.showAt()` - If a View is previously hidden, a `shown` event will be fired.
+ *
+ * * `view.attach()` - If a View is hidden and attached to a new Window, it will be shown and the `shown` event will be fired.
+ *
+ * * `view.create()` - A View `shown` event will be fired. (Internally the `attach` method is called when calling the `create` method, which fires the `shown` event.)
+ *
  * @interface
  */
 declare type ShownEvent = BaseEvent_4 & {

package/out/fdc3-api-public.d.ts

@@ -5344,6 +5344,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
      * @tutorial fdc3.open
      */
     protected _open(app: v1_2.TargetApp, context?: v1_2.Context): Promise<v2_0.AppIdentifier>;
+    protected _getChannels(): Promise<ChannelType[]>;
     /**
      * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
      * @param channelId
@@ -5960,6 +5961,13 @@ declare type GpuInfo = {
 
 /**
  * Generated when a View is hidden.
+ *
+ * @remarks
+ * An OpenFin View's `hidden` event is only emitted when a specific View API is called.
+ * This event can fire when calling:
+ *
+ * * `view.hide()` - If a View is previously shown, a `hidden` event will be fired.
+ *
  * @interface
  */
 declare type HiddenEvent = BaseEvent_4 & {
@@ -12565,7 +12573,18 @@ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
 };
 
 /**
- * Generated when a View is shown. This event will fire during creation of a View.
+ * Generated when a View is shown.
+ *
+ * @remarks
+ * An OpenFin View's `shown` event is only emitted when specific View APIs are called.
+ * This event can fire when calling:
+ *
+ * * `view.show()` or `view.showAt()` - If a View is previously hidden, a `shown` event will be fired.
+ *
+ * * `view.attach()` - If a View is hidden and attached to a new Window, it will be shown and the `shown` event will be fired.
+ *
+ * * `view.create()` - A View `shown` event will be fired. (Internally the `attach` method is called when calling the `create` method, which fires the `shown` event.)
+ *
  * @interface
  */
 declare type ShownEvent = BaseEvent_4 & {

package/out/fdc3-api.d.ts

@@ -5429,6 +5429,7 @@ declare class FDC3ModuleBase<ChannelType extends v1_2.Channel | v2_0.Channel> {
      * @tutorial fdc3.open
      */
     protected _open(app: v1_2.TargetApp, context?: v1_2.Context): Promise<v2_0.AppIdentifier>;
+    protected _getChannels(): Promise<ChannelType[]>;
     /**
      * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
      * @param channelId
@@ -6051,6 +6052,13 @@ declare type GpuInfo = {
 
 /**
  * Generated when a View is hidden.
+ *
+ * @remarks
+ * An OpenFin View's `hidden` event is only emitted when a specific View API is called.
+ * This event can fire when calling:
+ *
+ * * `view.hide()` - If a View is previously shown, a `hidden` event will be fired.
+ *
  * @interface
  */
 declare type HiddenEvent = BaseEvent_4 & {
@@ -12958,7 +12966,18 @@ declare type ShowAllDownloadsEvent = BaseEvent_5 & {
 };
 
 /**
- * Generated when a View is shown. This event will fire during creation of a View.
+ * Generated when a View is shown.
+ *
+ * @remarks
+ * An OpenFin View's `shown` event is only emitted when specific View APIs are called.
+ * This event can fire when calling:
+ *
+ * * `view.show()` or `view.showAt()` - If a View is previously hidden, a `shown` event will be fired.
+ *
+ * * `view.attach()` - If a View is hidden and attached to a new Window, it will be shown and the `shown` event will be fired.
+ *
+ * * `view.create()` - A View `shown` event will be fired. (Internally the `attach` method is called when calling the `create` method, which fires the `shown` event.)
+ *
  * @interface
  */
 declare type ShownEvent = BaseEvent_4 & {

package/out/fdc3-api.js

@@ -1819,6 +1819,14 @@ function requireFdc3Common () {
 	            throw new Error(errorToThrow);
 	        }
 	    }
+	    async _getChannels() {
+	        const channels = await this.client.getContextGroups();
+	        // fdc3 implementation of getSystemChannels returns an array of channels, have to decorate over
+	        // this so people know that these APIs are not supported
+	        return channels.map((channel) => {
+	            return { ...channel, type: 'system', ...(0, utils_1.getUnsupportedChannelApis)() };
+	        });
+	    }
 	    /**
 	     * Returns a Channel object for the specified channel, creating it as an App Channel if it does not exist.
 	     * @param channelId
@@ -1829,7 +1837,7 @@ function requireFdc3Common () {
 	        this.wire.sendAction('fdc3-get-or-create-channel').catch((e) => {
 	            // we do not want to expose this error, just continue if this analytics-only call fails
 	        });
-	        const systemChannels = await this.getSystemChannels();
+	        const systemChannels = await this._getChannels();
 	        const userChannel = systemChannels.find((channel) => channel.id === channelId);
 	        if (userChannel) {
 	            return { ...userChannel, type: 'system', ...(0, utils_1.getUnsupportedChannelApis)() };
@@ -1853,12 +1861,7 @@ function requireFdc3Common () {
 	        this.wire.sendAction('fdc3-get-system-channels').catch((e) => {
 	            // we do not want to expose this error, just continue if this analytics-only call fails
 	        });
-	        const channels = await this.client.getContextGroups();
-	        // fdc3 implementation of getSystemChannels returns on array of channels, have to decorate over
-	        // this so people know that these APIs are not supported
-	        return channels.map((channel) => {
-	            return { ...channel, type: 'system', ...(0, utils_1.getUnsupportedChannelApis)() };
-	        });
+	        return this._getChannels();
 	    }
 	    /**
 	     * Join all Interop Clients at the given identity to context group `contextGroupId`.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/fdc3-api",
-    "version": "38.81.34",
+    "version": "38.81.37",
     "description": "OpenFin fdc3 module utilities and types.",
     "license": "SEE LICENSE IN LICENSE.MD",
     "private": false,