@openfin/fdc3-api 43.100.35 → 43.100.36

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

@@ -9004,19 +9004,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;
 };
@@ -10011,6 +10066,7 @@ declare namespace OpenFin {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -13328,6 +13384,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
     'dispatch-notification-event': {
         request: {
             notificationId: string;
@@ -15874,6 +15936,10 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
 }
 
 /**

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

@@ -9004,19 +9004,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;
 };
@@ -10011,6 +10066,7 @@ declare namespace OpenFin {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -13328,6 +13384,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
     'dispatch-notification-event': {
         request: {
             notificationId: string;
@@ -15874,6 +15936,10 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
 }
 
 /**

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

@@ -9004,19 +9004,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;
 };
@@ -10011,6 +10066,7 @@ declare namespace OpenFin {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -13328,6 +13384,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
     'dispatch-notification-event': {
         request: {
             notificationId: string;
@@ -15874,6 +15936,10 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
 }
 
 /**

package/out/fdc3-api.d.ts

@@ -9300,19 +9300,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;
 };
@@ -10329,6 +10384,7 @@ declare namespace OpenFin {
         PlatformViewCreationOptions,
         ProcessAffinityStrategy,
         PlatformOptions,
+        LogUploaderOptions,
         LogUploaderUIOptions,
         LogUploadOptions,
         Manifest,
@@ -13729,6 +13785,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
+    'launch-log-uploader': ApiCall<{
+        options: OpenFin.LogUploaderOptions;
+    }, void> & {
+        apiPath: '.launchLogUploader';
+        namespace: 'System';
+    };
     'dispatch-notification-event': {
         request: {
             notificationId: string;
@@ -16281,6 +16343,10 @@ declare class System extends EmitterBase<OpenFin.SystemEvent> {
      * Not indended for general use, will be used by the `@openfin/workspace-platform` package.
      */
     serveAsset(options: OpenFin.ServeAssetOptions): Promise<OpenFin.ServedAssetInfo>;
+    /**
+     * Launches the Log Uploader. Full documentation can be found [here](https://resources.here.io/docs/core/develop/debug/log-uploader/).
+     */
+    launchLogUploader(options: OpenFin.LogUploaderOptions): Promise<void>;
 }
 
 /**

package/package.json

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