@openfin/fdc3-api 38.81.23 → 38.81.29

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

@@ -4521,6 +4521,17 @@ declare type DeviceInfo = {
     productId: string | number;
 };
 
+/**
+ * Permission string keys for device APIs
+ *
+ * @remarks We currently only support USB and HID devices.  Permissions for individual devices
+ * must be granted in {@link Permissions.devices}.
+ *
+ * `usb`: Access to one or more USB devices
+ * `hid : Access to one or more HID devices
+ */
+declare type DevicePermissionName = 'usb' | 'hid';
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -7888,9 +7899,7 @@ declare class InteropClient extends Base {
      * ```
      *
      *
-     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-     * this, please make sure you add your context handlers at the top level of your application, on a page that
-     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
      *
      * ```js
      * function handleInstrumentContext(contextInfo) {
@@ -10169,6 +10178,8 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        DevicePermissionName,
+        WebPermissionName,
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
@@ -14974,8 +14985,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     launchManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Manifest>;
     /**
      * Query permission of a secured api in current context.
+     *
      * @param apiName - The full name of a secured API.
      *
+     * @remarks If a function has a structured permission value, the value of `granted` will reflect the `enabled` key
+     * of the call's permissions literal.  In this case, *permission may still be denied to a call* pending arguments or other
+     * runtime state.  This is indicated with `state: unavailable`.
+     *
      * @example
      * ```js
      * fin.System.queryPermissionForCurrentContext('System.launchExternalProcess').then(result => console.log(result)).catch(err => console.log(err));
@@ -17550,18 +17566,38 @@ declare namespace WebContentsEvents {
  *
  * @remarks We only support those web APIs listed by electron.
  *
- * `audio`: Request access to audio devices.<br>
- * `video`: Request access to video devices.<br>
- * `geolocation`: Request access to user's current location.<br>
+ * `audio`: Access to audio devices.<br>
+ * `video`: Access to video devices.<br>
+ * `geolocation`: Access to user's current location.<br>
+ * `notifications`: Request notification creation and the ability to display them in the user's system tray.<br>
+ * `midiSysex`: Use of system exclusive messages in the webmidi API.<br>
+ * `pointerLock`: Access to mouse movements as an input method.<br>
+ * `fullscreen`: Access to fullscreen mode.<br>
+ * `openExternal`: Access to open links in external applications.<br>
+ * `clipboard-read`: Access to read from the clipboard.<br>
+ * `clipboard-sanitized-write`: Access to write to the clipboard.
+ * `usb`: Access to one or more USB devices
+ * `hid : Access to one or more HID devices
+ */
+declare type WebPermission = WebPermissionName | DevicePermissionName | OpenExternalPermission;
+
+/**
+ * Permission string keys for webAPIs
+ *
+ * @remarks We only support those web APIs listed by electron.
+ *
+ * `audio`: Access to audio devices.<br>
+ * `video`: Access to video devices.<br>
+ * `geolocation`: Access to user's current location.<br>
  * `notifications`: Request notification creation and the ability to display them in the user's system tray.<br>
- * `midiSysex`: Request the use of system exclusive messages in the webmidi API.<br>
- * `pointerLock`: Request to directly interpret mouse movements as an input method.<br>
- * `fullscreen`: Request for the app to enter fullscreen mode.<br>
- * `openExternal`: Request to open links in external applications.<br>
- * `clipboard-read`: Request access to read from the clipboard.<br>
- * `clipboard-sanitized-write`: Request access to write to the clipboard.
- */
-declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
+ * `midiSysex`: Use of system exclusive messages in the webmidi API.<br>
+ * `pointerLock`: Access to mouse movements as an input method.<br>
+ * `fullscreen`: Access to fullscreen mode.<br>
+ * `openExternal`: Access to open links in external applications.<br>
+ * `clipboard-read`: Access to read from the clipboard.<br>
+ * `clipboard-sanitized-write`: Access to write to the clipboard.
+ */
+declare type WebPermissionName = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write';
 
 /**
  * Object representing headers and their values, where the

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

@@ -4521,6 +4521,17 @@ declare type DeviceInfo = {
     productId: string | number;
 };
 
+/**
+ * Permission string keys for device APIs
+ *
+ * @remarks We currently only support USB and HID devices.  Permissions for individual devices
+ * must be granted in {@link Permissions.devices}.
+ *
+ * `usb`: Access to one or more USB devices
+ * `hid : Access to one or more HID devices
+ */
+declare type DevicePermissionName = 'usb' | 'hid';
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -7888,9 +7899,7 @@ declare class InteropClient extends Base {
      * ```
      *
      *
-     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-     * this, please make sure you add your context handlers at the top level of your application, on a page that
-     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
      *
      * ```js
      * function handleInstrumentContext(contextInfo) {
@@ -10169,6 +10178,8 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        DevicePermissionName,
+        WebPermissionName,
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
@@ -14974,8 +14985,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     launchManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Manifest>;
     /**
      * Query permission of a secured api in current context.
+     *
      * @param apiName - The full name of a secured API.
      *
+     * @remarks If a function has a structured permission value, the value of `granted` will reflect the `enabled` key
+     * of the call's permissions literal.  In this case, *permission may still be denied to a call* pending arguments or other
+     * runtime state.  This is indicated with `state: unavailable`.
+     *
      * @example
      * ```js
      * fin.System.queryPermissionForCurrentContext('System.launchExternalProcess').then(result => console.log(result)).catch(err => console.log(err));
@@ -17550,18 +17566,38 @@ declare namespace WebContentsEvents {
  *
  * @remarks We only support those web APIs listed by electron.
  *
- * `audio`: Request access to audio devices.<br>
- * `video`: Request access to video devices.<br>
- * `geolocation`: Request access to user's current location.<br>
+ * `audio`: Access to audio devices.<br>
+ * `video`: Access to video devices.<br>
+ * `geolocation`: Access to user's current location.<br>
+ * `notifications`: Request notification creation and the ability to display them in the user's system tray.<br>
+ * `midiSysex`: Use of system exclusive messages in the webmidi API.<br>
+ * `pointerLock`: Access to mouse movements as an input method.<br>
+ * `fullscreen`: Access to fullscreen mode.<br>
+ * `openExternal`: Access to open links in external applications.<br>
+ * `clipboard-read`: Access to read from the clipboard.<br>
+ * `clipboard-sanitized-write`: Access to write to the clipboard.
+ * `usb`: Access to one or more USB devices
+ * `hid : Access to one or more HID devices
+ */
+declare type WebPermission = WebPermissionName | DevicePermissionName | OpenExternalPermission;
+
+/**
+ * Permission string keys for webAPIs
+ *
+ * @remarks We only support those web APIs listed by electron.
+ *
+ * `audio`: Access to audio devices.<br>
+ * `video`: Access to video devices.<br>
+ * `geolocation`: Access to user's current location.<br>
  * `notifications`: Request notification creation and the ability to display them in the user's system tray.<br>
- * `midiSysex`: Request the use of system exclusive messages in the webmidi API.<br>
- * `pointerLock`: Request to directly interpret mouse movements as an input method.<br>
- * `fullscreen`: Request for the app to enter fullscreen mode.<br>
- * `openExternal`: Request to open links in external applications.<br>
- * `clipboard-read`: Request access to read from the clipboard.<br>
- * `clipboard-sanitized-write`: Request access to write to the clipboard.
- */
-declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
+ * `midiSysex`: Use of system exclusive messages in the webmidi API.<br>
+ * `pointerLock`: Access to mouse movements as an input method.<br>
+ * `fullscreen`: Access to fullscreen mode.<br>
+ * `openExternal`: Access to open links in external applications.<br>
+ * `clipboard-read`: Access to read from the clipboard.<br>
+ * `clipboard-sanitized-write`: Access to write to the clipboard.
+ */
+declare type WebPermissionName = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write';
 
 /**
  * Object representing headers and their values, where the

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

@@ -4521,6 +4521,17 @@ declare type DeviceInfo = {
     productId: string | number;
 };
 
+/**
+ * Permission string keys for device APIs
+ *
+ * @remarks We currently only support USB and HID devices.  Permissions for individual devices
+ * must be granted in {@link Permissions.devices}.
+ *
+ * `usb`: Access to one or more USB devices
+ * `hid : Access to one or more HID devices
+ */
+declare type DevicePermissionName = 'usb' | 'hid';
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -7888,9 +7899,7 @@ declare class InteropClient extends Base {
      * ```
      *
      *
-     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-     * this, please make sure you add your context handlers at the top level of your application, on a page that
-     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
      *
      * ```js
      * function handleInstrumentContext(contextInfo) {
@@ -10169,6 +10178,8 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        DevicePermissionName,
+        WebPermissionName,
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
@@ -14974,8 +14985,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     launchManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Manifest>;
     /**
      * Query permission of a secured api in current context.
+     *
      * @param apiName - The full name of a secured API.
      *
+     * @remarks If a function has a structured permission value, the value of `granted` will reflect the `enabled` key
+     * of the call's permissions literal.  In this case, *permission may still be denied to a call* pending arguments or other
+     * runtime state.  This is indicated with `state: unavailable`.
+     *
      * @example
      * ```js
      * fin.System.queryPermissionForCurrentContext('System.launchExternalProcess').then(result => console.log(result)).catch(err => console.log(err));
@@ -17550,18 +17566,38 @@ declare namespace WebContentsEvents {
  *
  * @remarks We only support those web APIs listed by electron.
  *
- * `audio`: Request access to audio devices.<br>
- * `video`: Request access to video devices.<br>
- * `geolocation`: Request access to user's current location.<br>
+ * `audio`: Access to audio devices.<br>
+ * `video`: Access to video devices.<br>
+ * `geolocation`: Access to user's current location.<br>
+ * `notifications`: Request notification creation and the ability to display them in the user's system tray.<br>
+ * `midiSysex`: Use of system exclusive messages in the webmidi API.<br>
+ * `pointerLock`: Access to mouse movements as an input method.<br>
+ * `fullscreen`: Access to fullscreen mode.<br>
+ * `openExternal`: Access to open links in external applications.<br>
+ * `clipboard-read`: Access to read from the clipboard.<br>
+ * `clipboard-sanitized-write`: Access to write to the clipboard.
+ * `usb`: Access to one or more USB devices
+ * `hid : Access to one or more HID devices
+ */
+declare type WebPermission = WebPermissionName | DevicePermissionName | OpenExternalPermission;
+
+/**
+ * Permission string keys for webAPIs
+ *
+ * @remarks We only support those web APIs listed by electron.
+ *
+ * `audio`: Access to audio devices.<br>
+ * `video`: Access to video devices.<br>
+ * `geolocation`: Access to user's current location.<br>
  * `notifications`: Request notification creation and the ability to display them in the user's system tray.<br>
- * `midiSysex`: Request the use of system exclusive messages in the webmidi API.<br>
- * `pointerLock`: Request to directly interpret mouse movements as an input method.<br>
- * `fullscreen`: Request for the app to enter fullscreen mode.<br>
- * `openExternal`: Request to open links in external applications.<br>
- * `clipboard-read`: Request access to read from the clipboard.<br>
- * `clipboard-sanitized-write`: Request access to write to the clipboard.
- */
-declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
+ * `midiSysex`: Use of system exclusive messages in the webmidi API.<br>
+ * `pointerLock`: Access to mouse movements as an input method.<br>
+ * `fullscreen`: Access to fullscreen mode.<br>
+ * `openExternal`: Access to open links in external applications.<br>
+ * `clipboard-read`: Access to read from the clipboard.<br>
+ * `clipboard-sanitized-write`: Access to write to the clipboard.
+ */
+declare type WebPermissionName = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write';
 
 /**
  * Object representing headers and their values, where the

package/out/fdc3-api.d.ts

@@ -4580,6 +4580,17 @@ declare type DeviceInfo = {
     productId: string | number;
 };
 
+/**
+ * Permission string keys for device APIs
+ *
+ * @remarks We currently only support USB and HID devices.  Permissions for individual devices
+ * must be granted in {@link Permissions.devices}.
+ *
+ * `usb`: Access to one or more USB devices
+ * `hid : Access to one or more HID devices
+ */
+declare type DevicePermissionName = 'usb' | 'hid';
+
 /**
  * Generated when a page's theme color changes. This is usually due to encountering a meta tag.
  * @interface
@@ -8000,9 +8011,7 @@ declare class InteropClient extends Base {
      * ```
      *
      *
-     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-     * this, please make sure you add your context handlers at the top level of your application, on a page that
-     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
      *
      * ```js
      * function handleInstrumentContext(contextInfo) {
@@ -10484,6 +10493,8 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        DevicePermissionName,
+        WebPermissionName,
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
@@ -15373,8 +15384,13 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
     launchManifest(manifestUrl: string, opts?: OpenFin.RvmLaunchOptions): Promise<OpenFin.Manifest>;
     /**
      * Query permission of a secured api in current context.
+     *
      * @param apiName - The full name of a secured API.
      *
+     * @remarks If a function has a structured permission value, the value of `granted` will reflect the `enabled` key
+     * of the call's permissions literal.  In this case, *permission may still be denied to a call* pending arguments or other
+     * runtime state.  This is indicated with `state: unavailable`.
+     *
      * @example
      * ```js
      * fin.System.queryPermissionForCurrentContext('System.launchExternalProcess').then(result => console.log(result)).catch(err => console.log(err));
@@ -17993,18 +18009,38 @@ declare namespace WebContentsEvents {
  *
  * @remarks We only support those web APIs listed by electron.
  *
- * `audio`: Request access to audio devices.<br>
- * `video`: Request access to video devices.<br>
- * `geolocation`: Request access to user's current location.<br>
+ * `audio`: Access to audio devices.<br>
+ * `video`: Access to video devices.<br>
+ * `geolocation`: Access to user's current location.<br>
+ * `notifications`: Request notification creation and the ability to display them in the user's system tray.<br>
+ * `midiSysex`: Use of system exclusive messages in the webmidi API.<br>
+ * `pointerLock`: Access to mouse movements as an input method.<br>
+ * `fullscreen`: Access to fullscreen mode.<br>
+ * `openExternal`: Access to open links in external applications.<br>
+ * `clipboard-read`: Access to read from the clipboard.<br>
+ * `clipboard-sanitized-write`: Access to write to the clipboard.
+ * `usb`: Access to one or more USB devices
+ * `hid : Access to one or more HID devices
+ */
+declare type WebPermission = WebPermissionName | DevicePermissionName | OpenExternalPermission;
+
+/**
+ * Permission string keys for webAPIs
+ *
+ * @remarks We only support those web APIs listed by electron.
+ *
+ * `audio`: Access to audio devices.<br>
+ * `video`: Access to video devices.<br>
+ * `geolocation`: Access to user's current location.<br>
  * `notifications`: Request notification creation and the ability to display them in the user's system tray.<br>
- * `midiSysex`: Request the use of system exclusive messages in the webmidi API.<br>
- * `pointerLock`: Request to directly interpret mouse movements as an input method.<br>
- * `fullscreen`: Request for the app to enter fullscreen mode.<br>
- * `openExternal`: Request to open links in external applications.<br>
- * `clipboard-read`: Request access to read from the clipboard.<br>
- * `clipboard-sanitized-write`: Request access to write to the clipboard.
- */
-declare type WebPermission = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
+ * `midiSysex`: Use of system exclusive messages in the webmidi API.<br>
+ * `pointerLock`: Access to mouse movements as an input method.<br>
+ * `fullscreen`: Access to fullscreen mode.<br>
+ * `openExternal`: Access to open links in external applications.<br>
+ * `clipboard-read`: Access to read from the clipboard.<br>
+ * `clipboard-sanitized-write`: Access to write to the clipboard.
+ */
+declare type WebPermissionName = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write';
 
 /**
  * Object representing headers and their values, where the

package/out/fdc3-api.js

@@ -1292,9 +1292,7 @@ function requireInteropClient () {
 	     * ```
 	     *
 	     *
-	     * We are also testing the ability to add a context handler for specific contexts. If you would like to use
-	     * this, please make sure you add your context handlers at the top level of your application, on a page that
-	     * does not navigate/reload/re-render, to avoid memory leaks.  This feature is experimental:
+	     * Passing in a context type as the second parameter will cause the handler to only be invoked with that context type.
 	     *
 	     * ```js
 	     * function handleInstrumentContext(contextInfo) {
@@ -1323,7 +1321,6 @@ function requireInteropClient () {
 	        let handlerId;
 	        if (contextType) {
 	            handlerId = `invokeContextHandler-${contextType}-${(0, utils_1.generateId)()}`;
-	            console.warn(`Warning: By providing a contextType (${contextType}), you are using the experimental addContextHandler. To avoid issues, make sure you are adding your context handlers at the top level in your application.`);
 	        }
 	        else {
 	            handlerId = 'invokeContextHandler';

package/package.json

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