@openfin/core 32.75.18 → 32.75.20

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "32.75.18",
+    "version": "32.75.20",
     "license": "SEE LICENSE IN LICENSE.MD",
     "main": "./src/mock.js",
     "types": "./src/mock.d.ts",

package/src/OpenFin.d.ts

@@ -1433,6 +1433,7 @@ export type GetWindowContextPayload = {
 };
 export type ApplicationPermissions = {
     setFileDownloadLocation: boolean;
+    getFileDownloadLocation: boolean;
 };
 export type LaunchExternalProcessRule = {
     behavior: 'allow' | 'block';

package/src/api/application/Instance.d.ts

@@ -300,10 +300,22 @@ export declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     getProcessInfo(): Promise<OpenFin.AppProcessInfo>;
     /**
-     * Sets file auto download location.
+     * Sets file auto download location. It's only allowed in the same application.
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param { string } downloadLocation file auto download location
      * @return {Promise.<void>}
+     * @throws if setting file auto download location on different applications.
      * @tutorial Application.setFileDownloadLocation
      */
     setFileDownloadLocation(downloadLocation: string): Promise<void>;
+    /**
+     * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * @return {Promise.<string>}
+     * @throws if getting file auto download location on different applications.
+     * @tutorial Application.getFileDownloadLocation
+     */
+    getFileDownloadLocation(): Promise<string>;
 }

package/src/api/application/Instance.js

@@ -146,11 +146,8 @@ class Application extends base_1.EmitterBase {
             await this.wire.sendAction('destroy-application', { force, ...this.identity });
         }
         catch (error) {
-            const acceptableErrors = [
-                'Remote connection has closed',
-                'Could not locate the requested application'
-            ];
-            if (!acceptableErrors.some(msg => error.message.includes(msg))) {
+            const acceptableErrors = ['Remote connection has closed', 'Could not locate the requested application'];
+            if (!acceptableErrors.some((msg) => error.message.includes(msg))) {
                 throw error;
             }
         }
@@ -427,13 +424,30 @@ class Application extends base_1.EmitterBase {
         return data;
     }
     /**
-     * Sets file auto download location.
+     * Sets file auto download location. It's only allowed in the same application.
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
      * @param { string } downloadLocation file auto download location
      * @return {Promise.<void>}
+     * @throws if setting file auto download location on different applications.
      * @tutorial Application.setFileDownloadLocation
      */
     async setFileDownloadLocation(downloadLocation) {
-        await this.wire.sendAction('set-file-download-location', { downloadLocation, ...this.identity });
+        const { name } = this.wire.me;
+        const entityIdentity = { uuid: this.identity.uuid, name };
+        await this.wire.sendAction('set-file-download-location', { ...entityIdentity, downloadLocation });
+    }
+    /**
+     * Gets file auto download location. It's only allowed in the same application. If file auto download location is not set, it will return the default location.
+     * Note: This method is restricted by default and must be enabled via
+     * <a href="https://developers.openfin.co/docs/api-security">API security settings</a>.
+     * @return {Promise.<string>}
+     * @throws if getting file auto download location on different applications.
+     * @tutorial Application.getFileDownloadLocation
+     */
+    async getFileDownloadLocation() {
+        const { payload: { data } } = await this.wire.sendAction('get-file-download-location', this.identity);
+        return data;
     }
 }
 exports.Application = Application;

package/src/api/events/application.d.ts

@@ -11,6 +11,9 @@ export type CrashedEvent = NamedEvent & {
         exitCode: number;
     };
 };
+export type FileDownloadLocationChangedEvent = NamedEvent & {
+    type: 'file-download-location-changed';
+};
 export type RunRequestedEvent = IdentityEvent & {
     type: 'run-requested';
     userAppConfigArgs: Record<string, any>;
@@ -70,7 +73,7 @@ export type StartedEvent = IdentityEvent & {
 /**
  * An Application event that does propagate to (republish on) parent topics.
  */
-export type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent | StartedEvent | TrayIconClickedEvent;
+export type WillPropagateApplicationEvent = ClosedEvent | ApplicationConnectedEvent | CrashedEvent | InitializedEvent | ManifestChangedEvent | NotRespondingEvent | RespondingEvent | RunRequestedEvent | StartedEvent | TrayIconClickedEvent | FileDownloadLocationChangedEvent;
 export type ApplicationEvent = {
     topic: 'application';
 } & (PropagatedViewEvent | PropagatedWindowEvent | ApplicationWindowEvent | WillPropagateApplicationEvent);

package/src/api/interappbus/channel/index.js

@@ -77,7 +77,10 @@ class Channel extends base_1.EmitterBase {
         }
         try {
             const { offer, rtc: rtcPacket } = await __classPrivateFieldGet(this, _Channel_connectionManager, "f").createClientOffer(opts);
-            const connectionUrl = (await this.fin.me.getInfo()).url;
+            let connectionUrl;
+            if (this.fin.me.isFrame || this.fin.me.isView || this.fin.me.isWindow) {
+                connectionUrl = (await this.fin.me.getInfo()).url;
+            }
             const { payload: { data: routingInfo } } = await this.wire.sendAction('connect-to-channel', {
                 channelName,
                 ...opts,

package/src/api/me.d.ts

@@ -33,7 +33,7 @@ export declare function getBaseMe<T extends EntityType = EntityType>(entityType:
 export interface WithInterop {
     interop: InteropClient;
 }
-export type Me<MeType extends EntityType> = OpenFin.EntityInfo & (MeType extends 'view' ? EntityTypeHelpers<'view'> & OpenFin.View & WithInterop : MeType extends 'window' ? EntityTypeHelpers<'window'> & OpenFin.Window & WithInterop : MeType extends 'iframe' ? EntityTypeHelpers<'iframe'> & OpenFin.Frame & WithInterop : EntityTypeHelpers<MeType> & WithInterop) & {
+export type Me<MeType extends EntityType> = OpenFin.EntityInfo & (MeType extends 'view' ? EntityTypeHelpers<'view'> & OpenFin.View & WithInterop : MeType extends 'window' ? EntityTypeHelpers<'window'> & OpenFin.Window & WithInterop : MeType extends 'iframe' ? EntityTypeHelpers<'iframe'> & OpenFin.Frame & WithInterop : MeType extends 'external connection' ? EntityTypeHelpers<'external connection'> & OpenFin.ExternalApplication & WithInterop : EntityTypeHelpers<MeType> & WithInterop) & {
     isOpenFin: boolean;
 };
 export declare function getMe<MeType extends EntityType>(wire: Transport<MeType>): Me<MeType>;

package/src/api/me.js

@@ -4,6 +4,7 @@ exports.getMe = exports.getBaseMe = exports.environmentUnsupportedMessage = void
 const view_1 = require("./view");
 const frame_1 = require("./frame");
 const window_1 = require("./window");
+const external_application_1 = require("./external-application");
 exports.environmentUnsupportedMessage = 'You are not running in OpenFin.';
 function getBaseMe(entityType, uuid, name) {
     const entityTypeHelpers = {
@@ -117,7 +118,7 @@ function getMe(wire) {
                 isOpenFin: true
             });
         case 'external connection':
-            return Object.assign(new window_1._Window(wire, { uuid, name }), getBaseMe(entityType, uuid, name), {
+            return Object.assign(new external_application_1.ExternalApplication(wire, { uuid }), getBaseMe(entityType, uuid, name), {
                 interop: fallbackInterop,
                 isOpenFin: false
             });

package/src/shapes/protocol.d.ts

@@ -85,11 +85,15 @@ export interface ProtocolMap extends ProtocolMapBase {
     'get-permissions': GetterCall<any>;
     'get-all-channels': GetterCall<OpenFin.ProviderIdentity[]>;
     'set-file-download-location': {
-        request: OpenFin.ApplicationIdentity & {
+        request: OpenFin.Identity & {
             downloadLocation: string;
         };
         response: void;
     };
+    'get-file-download-location': {
+        request: OpenFin.ApplicationIdentity;
+        response: string;
+    };
     'close-popup-menu': IdentityCall;
     'fdc3-add-context-listener': VoidCall;
     'fdc3-broadcast': VoidCall;