@openfin/core 43.100.35 → 43.100.36

package/out/mock-alpha.d.ts

@@ -8662,19 +8662,74 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+/**
+ * Options for the Log Uploader.
+ */
+declare type LogUploaderOptions = LogUploadOptions & {
+    ui?: LogUploaderUIOptions & {
+        /**
+         * Whether the Log Uploader UI should be shown.
+         * @defaultValue true
+         */
+        show?: boolean;
+    };
+};
+
+/**
+ * Options for the Log Uploader UI.
+ * @interface
+ */
 declare type LogUploaderUIOptions = {
+    /**
+     * Title for the Log Uploader window.
+     * @defaultValue 'Here Log Uploader'
+     */
     title?: string;
+    /**
+     * URL of an icon to use for the Log Uploader tool. The default is the Here logo.
+     */
     icon?: string;
+    /**
+     * Name of the organization displayed in the Uploader window.
+     * @defaultValue 'Here'
+     */
     header?: string;
+    /**
+     * An explanation for the user of the purpose of the tool.
+     * @defaultValue 'The following logs are being requested'
+     */
     description?: string;
+    /**
+     * An email address that the user can contact with questions.
+     * @defaultValue 'support@here.io'
+     */
     email?: string;
+    /**
+     * URL of a webpage where the user can find more information about log uploading.
+     * @defaultValue 'https://resources.here.io/docs/core/manage/security/'
+     */
     website?: string;
+    /**
+     * Description of the webpage where the user can find more information.
+     * @defaultValue 'Here Security'
+     */
     websiteDescription?: string;
 };
 
 declare type LogUploadOptions = {
+    /**
+     * The URL where log files are to be uploaded.
+     */
     endpoint: string;
+    /**
+     * An array of URL match patterns to define the manifests of the programs that the Log Uploader should upload logs for.
+     * @defaultValue []
+     */
     manifests?: string[];
+    /**
+     * An array of strings that specifies which logs should be uploaded.
+     * @defaultValue ['app', 'rvm', 'debug']
+     */
     logs?: string[];
     ui?: LogUploaderUIOptions;
 };
@@ -9669,6 +9724,7 @@ declare namespace OpenFin_2 {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -12988,6 +13044,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin_2.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
     'dispatch-notification-event': {
         request: {
             notificationId: string;
@@ -15534,6 +15596,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin_2.ServeAssetOptions): Promise<OpenFin_2.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin_2.LogUploaderOptions): Promise<void>;
 }
 
 /**

package/out/mock-beta.d.ts

@@ -8662,19 +8662,74 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+/**
+ * Options for the Log Uploader.
+ */
+declare type LogUploaderOptions = LogUploadOptions & {
+    ui?: LogUploaderUIOptions & {
+        /**
+         * Whether the Log Uploader UI should be shown.
+         * @defaultValue true
+         */
+        show?: boolean;
+    };
+};
+
+/**
+ * Options for the Log Uploader UI.
+ * @interface
+ */
 declare type LogUploaderUIOptions = {
+    /**
+     * Title for the Log Uploader window.
+     * @defaultValue 'Here Log Uploader'
+     */
     title?: string;
+    /**
+     * URL of an icon to use for the Log Uploader tool. The default is the Here logo.
+     */
     icon?: string;
+    /**
+     * Name of the organization displayed in the Uploader window.
+     * @defaultValue 'Here'
+     */
     header?: string;
+    /**
+     * An explanation for the user of the purpose of the tool.
+     * @defaultValue 'The following logs are being requested'
+     */
     description?: string;
+    /**
+     * An email address that the user can contact with questions.
+     * @defaultValue 'support@here.io'
+     */
     email?: string;
+    /**
+     * URL of a webpage where the user can find more information about log uploading.
+     * @defaultValue 'https://resources.here.io/docs/core/manage/security/'
+     */
     website?: string;
+    /**
+     * Description of the webpage where the user can find more information.
+     * @defaultValue 'Here Security'
+     */
     websiteDescription?: string;
 };
 
 declare type LogUploadOptions = {
+    /**
+     * The URL where log files are to be uploaded.
+     */
     endpoint: string;
+    /**
+     * An array of URL match patterns to define the manifests of the programs that the Log Uploader should upload logs for.
+     * @defaultValue []
+     */
     manifests?: string[];
+    /**
+     * An array of strings that specifies which logs should be uploaded.
+     * @defaultValue ['app', 'rvm', 'debug']
+     */
     logs?: string[];
     ui?: LogUploaderUIOptions;
 };
@@ -9669,6 +9724,7 @@ declare namespace OpenFin_2 {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -12988,6 +13044,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin_2.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
     'dispatch-notification-event': {
         request: {
             notificationId: string;
@@ -15534,6 +15596,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin_2.ServeAssetOptions): Promise<OpenFin_2.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin_2.LogUploaderOptions): Promise<void>;
 }
 
 /**

package/out/mock-public.d.ts

@@ -8662,19 +8662,74 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+/**
+ * Options for the Log Uploader.
+ */
+declare type LogUploaderOptions = LogUploadOptions & {
+    ui?: LogUploaderUIOptions & {
+        /**
+         * Whether the Log Uploader UI should be shown.
+         * @defaultValue true
+         */
+        show?: boolean;
+    };
+};
+
+/**
+ * Options for the Log Uploader UI.
+ * @interface
+ */
 declare type LogUploaderUIOptions = {
+    /**
+     * Title for the Log Uploader window.
+     * @defaultValue 'Here Log Uploader'
+     */
     title?: string;
+    /**
+     * URL of an icon to use for the Log Uploader tool. The default is the Here logo.
+     */
     icon?: string;
+    /**
+     * Name of the organization displayed in the Uploader window.
+     * @defaultValue 'Here'
+     */
     header?: string;
+    /**
+     * An explanation for the user of the purpose of the tool.
+     * @defaultValue 'The following logs are being requested'
+     */
     description?: string;
+    /**
+     * An email address that the user can contact with questions.
+     * @defaultValue 'support@here.io'
+     */
     email?: string;
+    /**
+     * URL of a webpage where the user can find more information about log uploading.
+     * @defaultValue 'https://resources.here.io/docs/core/manage/security/'
+     */
     website?: string;
+    /**
+     * Description of the webpage where the user can find more information.
+     * @defaultValue 'Here Security'
+     */
     websiteDescription?: string;
 };
 
 declare type LogUploadOptions = {
+    /**
+     * The URL where log files are to be uploaded.
+     */
     endpoint: string;
+    /**
+     * An array of URL match patterns to define the manifests of the programs that the Log Uploader should upload logs for.
+     * @defaultValue []
+     */
     manifests?: string[];
+    /**
+     * An array of strings that specifies which logs should be uploaded.
+     * @defaultValue ['app', 'rvm', 'debug']
+     */
     logs?: string[];
     ui?: LogUploaderUIOptions;
 };
@@ -9669,6 +9724,7 @@ declare namespace OpenFin_2 {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -12988,6 +13044,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin_2.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
     'dispatch-notification-event': {
         request: {
             notificationId: string;
@@ -15534,6 +15596,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin_2.ServeAssetOptions): Promise<OpenFin_2.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin_2.LogUploaderOptions): Promise<void>;
 }
 
 /**

package/out/stub.d.ts

@@ -8958,19 +8958,74 @@ declare type LogInfo = {
  */
 declare type LogLevel = 'verbose' | 'info' | 'warning' | 'error' | 'fatal';
 
+/**
+ * Options for the Log Uploader.
+ */
+declare type LogUploaderOptions = LogUploadOptions & {
+    ui?: LogUploaderUIOptions & {
+        /**
+         * Whether the Log Uploader UI should be shown.
+         * @defaultValue true
+         */
+        show?: boolean;
+    };
+};
+
+/**
+ * Options for the Log Uploader UI.
+ * @interface
+ */
 declare type LogUploaderUIOptions = {
+    /**
+     * Title for the Log Uploader window.
+     * @defaultValue 'Here Log Uploader'
+     */
     title?: string;
+    /**
+     * URL of an icon to use for the Log Uploader tool. The default is the Here logo.
+     */
     icon?: string;
+    /**
+     * Name of the organization displayed in the Uploader window.
+     * @defaultValue 'Here'
+     */
     header?: string;
+    /**
+     * An explanation for the user of the purpose of the tool.
+     * @defaultValue 'The following logs are being requested'
+     */
     description?: string;
+    /**
+     * An email address that the user can contact with questions.
+     * @defaultValue 'support@here.io'
+     */
     email?: string;
+    /**
+     * URL of a webpage where the user can find more information about log uploading.
+     * @defaultValue 'https://resources.here.io/docs/core/manage/security/'
+     */
     website?: string;
+    /**
+     * Description of the webpage where the user can find more information.
+     * @defaultValue 'Here Security'
+     */
     websiteDescription?: string;
 };
 
 declare type LogUploadOptions = {
+    /**
+     * The URL where log files are to be uploaded.
+     */
     endpoint: string;
+    /**
+     * An array of URL match patterns to define the manifests of the programs that the Log Uploader should upload logs for.
+     * @defaultValue []
+     */
     manifests?: string[];
+    /**
+     * An array of strings that specifies which logs should be uploaded.
+     * @defaultValue ['app', 'rvm', 'debug']
+     */
     logs?: string[];
     ui?: LogUploaderUIOptions;
 };
@@ -9987,6 +10042,7 @@ declare namespace OpenFin_2 {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -13389,6 +13445,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin_2.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
     'dispatch-notification-event': {
         request: {
             notificationId: string;
@@ -15941,6 +16003,10 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin_2.ServeAssetOptions): Promise<OpenFin_2.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin_2.LogUploaderOptions): Promise<void>;
 }
 
 /**

package/out/stub.js

@@ -7332,6 +7332,12 @@ class System extends base_1$m.EmitterBase {
     async serveAsset(options) {
         return (await this.wire.sendAction('serve-asset', { options })).payload.data;
     }
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    async launchLogUploader(options) {
+        return (await this.wire.sendAction('launch-log-uploader', { options })).payload.data;
+    }
 }
 system.System = System;
 

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@openfin/core",
-    "version": "43.100.35",
+    "version": "43.100.36",
     "description": "The core renderer entry point of OpenFin",
     "license": "SEE LICENSE IN LICENSE.md",
     "main": "out/stub.js",