@openfin/node-adapter 38.81.24 → 38.81.30

package/out/node-adapter-alpha.d.ts

@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
-     * CLoses the tray icon menu.
+     * Closes the tray icon menu.
      *
      * @throws if the application has no tray icon set
      * @example
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions | PlatformOptions;
+    initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -4525,6 +4525,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
@@ -9833,6 +9844,8 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        DevicePermissionName,
+        WebPermissionName,
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
@@ -9896,6 +9909,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -12722,7 +12736,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
 declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
     topic: 'application';
     type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
+    userAppConfigArgs: OpenFin.UserAppConfigArgs;
     manifest: OpenFin.Manifest;
 };
 
@@ -12837,7 +12851,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -14639,8 +14653,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));
@@ -15361,6 +15380,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * @interface
+ */
+declare type UserAppConfigArgs = Record<string, string | string[]>;
+
 /**
  * A general user bounds change event without event type.
  * @interface
@@ -17215,18 +17239,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`: 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.
+ * `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 = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
+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`: 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
@@ -18747,6 +18791,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
     positioningOptions?: OpenFin.PositioningOptions;
 };
 
+declare type WithUserAppConfigArgs = {
+    /**
+     * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
+     * that launches this application.
+     *
+     * @remarks
+     * In the link, user defined parameters are separated by the `$$` delimeter, for example:
+     * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
+     *
+     * Results in the following object:
+     * ```json
+     * {
+     *    "use-last-configuration": true"
+     * }
+     * ```
+     *
+     * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
+     * ```typescript
+     * const appInfo = await fin.Application.getCurrentSync().getInfo();
+     * const { userAppConfigArgs } = appInfo.initialOptions;
+     * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
+     * ```
+     */
+    userAppConfigArgs?: UserAppConfigArgs;
+};
+
 /* Excluded from this release type: WorkspacePlatformOptions */
 
 /**

package/out/node-adapter-beta.d.ts

@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
-     * CLoses the tray icon menu.
+     * Closes the tray icon menu.
      *
      * @throws if the application has no tray icon set
      * @example
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions | PlatformOptions;
+    initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -4525,6 +4525,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
@@ -9833,6 +9844,8 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        DevicePermissionName,
+        WebPermissionName,
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
@@ -9896,6 +9909,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -12722,7 +12736,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
 declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
     topic: 'application';
     type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
+    userAppConfigArgs: OpenFin.UserAppConfigArgs;
     manifest: OpenFin.Manifest;
 };
 
@@ -12837,7 +12851,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -14639,8 +14653,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));
@@ -15361,6 +15380,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * @interface
+ */
+declare type UserAppConfigArgs = Record<string, string | string[]>;
+
 /**
  * A general user bounds change event without event type.
  * @interface
@@ -17215,18 +17239,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`: 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.
+ * `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 = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
+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`: 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
@@ -18747,6 +18791,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
     positioningOptions?: OpenFin.PositioningOptions;
 };
 
+declare type WithUserAppConfigArgs = {
+    /**
+     * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
+     * that launches this application.
+     *
+     * @remarks
+     * In the link, user defined parameters are separated by the `$$` delimeter, for example:
+     * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
+     *
+     * Results in the following object:
+     * ```json
+     * {
+     *    "use-last-configuration": true"
+     * }
+     * ```
+     *
+     * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
+     * ```typescript
+     * const appInfo = await fin.Application.getCurrentSync().getInfo();
+     * const { userAppConfigArgs } = appInfo.initialOptions;
+     * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
+     * ```
+     */
+    userAppConfigArgs?: UserAppConfigArgs;
+};
+
 /* Excluded from this release type: WorkspacePlatformOptions */
 
 /**

package/out/node-adapter-public.d.ts

@@ -825,7 +825,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
-     * CLoses the tray icon menu.
+     * Closes the tray icon menu.
      *
      * @throws if the application has no tray icon set
      * @example
@@ -934,7 +934,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions | PlatformOptions;
+    initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -4525,6 +4525,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
@@ -9833,6 +9844,8 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        DevicePermissionName,
+        WebPermissionName,
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
@@ -9896,6 +9909,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -12722,7 +12736,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
 declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
     topic: 'application';
     type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
+    userAppConfigArgs: OpenFin.UserAppConfigArgs;
     manifest: OpenFin.Manifest;
 };
 
@@ -12837,7 +12851,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -14639,8 +14653,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));
@@ -15361,6 +15380,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * @interface
+ */
+declare type UserAppConfigArgs = Record<string, string | string[]>;
+
 /**
  * A general user bounds change event without event type.
  * @interface
@@ -17215,18 +17239,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`: 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.
+ * `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 = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
+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`: 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
@@ -18747,6 +18791,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
     positioningOptions?: OpenFin.PositioningOptions;
 };
 
+declare type WithUserAppConfigArgs = {
+    /**
+     * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
+     * that launches this application.
+     *
+     * @remarks
+     * In the link, user defined parameters are separated by the `$$` delimeter, for example:
+     * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
+     *
+     * Results in the following object:
+     * ```json
+     * {
+     *    "use-last-configuration": true"
+     * }
+     * ```
+     *
+     * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
+     * ```typescript
+     * const appInfo = await fin.Application.getCurrentSync().getInfo();
+     * const { userAppConfigArgs } = appInfo.initialOptions;
+     * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
+     * ```
+     */
+    userAppConfigArgs?: UserAppConfigArgs;
+};
+
 /* Excluded from this release type: WorkspacePlatformOptions */
 
 /**

package/out/node-adapter.d.ts

@@ -831,7 +831,7 @@ declare class Application extends EmitterBase<OpenFin.ApplicationEvent> {
      */
     showTrayIconPopupMenu<Data>(options: OpenFin.ShowTrayIconPopupMenuOptions<Data>): Promise<OpenFin.MenuResult<Data>>;
     /**
-     * CLoses the tray icon menu.
+     * Closes the tray icon menu.
      *
      * @throws if the application has no tray icon set
      * @example
@@ -940,7 +940,7 @@ declare type ApplicationIdentity_2 = {
  * @interface
  */
 declare type ApplicationInfo = {
-    initialOptions: ApplicationCreationOptions | PlatformOptions;
+    initialOptions: WithUserAppConfigArgs & (ApplicationCreationOptions | PlatformOptions);
     launchMode: string;
     manifest: Manifest & {
         [key: string]: any;
@@ -4584,6 +4584,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
@@ -10170,6 +10181,8 @@ declare namespace OpenFin {
         ApplicationPermissions,
         LaunchExternalProcessRule,
         SystemPermissions,
+        DevicePermissionName,
+        WebPermissionName,
         WebPermission,
         VerboseWebPermission,
         OpenExternalPermission,
@@ -10233,6 +10246,7 @@ declare namespace OpenFin {
         AppVersionError,
         AppVersionRuntimeInfo,
         LaunchEmitter,
+        UserAppConfigArgs,
         RvmLaunchOptions,
         ShortCutConfig,
         TerminateExternalRequestType,
@@ -13137,7 +13151,7 @@ declare type RunRequestedEvent = OpenFin.ApplicationEvents.RunRequestedEvent;
 declare type RunRequestedEvent_2 = BaseEvents.IdentityEvent & {
     topic: 'application';
     type: 'run-requested';
-    userAppConfigArgs: Record<string, any>;
+    userAppConfigArgs: OpenFin.UserAppConfigArgs;
     manifest: OpenFin.Manifest;
 };
 
@@ -13252,7 +13266,7 @@ declare type RvmLaunchOptions = {
      * True if no UI when launching
      */
     noUi?: boolean;
-    userAppConfigArgs?: object;
+    userAppConfigArgs?: UserAppConfigArgs;
     /**
      * Timeout in seconds until RVM launch request expires.
      */
@@ -15060,8 +15074,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));
@@ -15789,6 +15808,11 @@ declare type UrlChangedEvent = BaseUrlEvent & ({
     httpStatusText: string;
 });
 
+/**
+ * @interface
+ */
+declare type UserAppConfigArgs = Record<string, string | string[]>;
+
 /**
  * A general user bounds change event without event type.
  * @interface
@@ -17680,18 +17704,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`: 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.
+ * `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 = 'audio' | 'video' | 'geolocation' | 'notifications' | 'midiSysex' | 'pointerLock' | 'fullscreen' | 'openExternal' | 'clipboard-read' | 'clipboard-sanitized-write' | 'hid' | 'usb' | OpenExternalPermission;
+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`: 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
@@ -19221,6 +19265,32 @@ declare type WithPositioningOptions<T extends {} = {}> = T & {
     positioningOptions?: OpenFin.PositioningOptions;
 };
 
+declare type WithUserAppConfigArgs = {
+    /**
+     * Represents the key-value pairs for the parameters passed into any fin:// or fins:// link
+     * that launches this application.
+     *
+     * @remarks
+     * In the link, user defined parameters are separated by the `$$` delimeter, for example:
+     * `fins://path.to/app/manifest.json?$$use-last-configuration=true`
+     *
+     * Results in the following object:
+     * ```json
+     * {
+     *    "use-last-configuration": true"
+     * }
+     * ```
+     *
+     * These args can be accessed via the {@link ApplicationInfo.initialOptions} object:
+     * ```typescript
+     * const appInfo = await fin.Application.getCurrentSync().getInfo();
+     * const { userAppConfigArgs } = appInfo.initialOptions;
+     * console.log(userAppConfigArgs['use-last-configuration']); // 'true'
+     * ```
+     */
+    userAppConfigArgs?: UserAppConfigArgs;
+};
+
 /**
  * @internal
  * @interface

package/out/node-adapter.js

@@ -3799,7 +3799,7 @@ function requireInstance$1 () {
 	        return payload.data;
 	    }
 	    /**
-	     * CLoses the tray icon menu.
+	     * Closes the tray icon menu.
 	     *
 	     * @throws if the application has no tray icon set
 	     * @example
@@ -7273,8 +7273,13 @@ class System extends base_1$i.EmitterBase {
     }
     /**
      * 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));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/node-adapter",
-    "version": "38.81.24",
+    "version": "38.81.30",
     "description": "See README.md",
     "main": "out/node-adapter.js",
     "types": "out/node-adapter.d.ts",