@openfin/core 43.103.2 → 43.104.1

package/out/stub.d.ts

@@ -88,7 +88,7 @@ declare type AlertRequestedEvent = BaseEvent_5 & {
     url: string;
 };
 
-declare type AnalyticsOnlyCalls = 'window-get-web-window' | 'layout-get-by-view-identity' | 'layout-get-stack-by-view' | 'layout-add-view' | 'layout-close-view' | 'view-get-parent-layout' | 'view-get-current-stack' | 'window-is-main-window' | 'window-get-parent-application' | 'window-get-parent-window' | 'window-create-window' | 'window-get-layout' | 'window-dispatch-popup-result' | `layout-controller-${string}`;
+declare type AnalyticsOnlyCalls = 'layout-get-stack-by-view' | 'layout-add-view' | 'layout-close-view' | `layout-controller-${string}`;
 
 declare type AnalyticsProtocolMap = {
     [k in AnalyticsOnlyCalls]: VoidCall;
@@ -1789,6 +1789,7 @@ declare type BaseConfig = {
     devToolsPort?: number;
     installerUI?: boolean;
     runtime?: RuntimeConfig;
+    apiDiagnostics?: boolean;
     appAssets?: [
         {
         src: string;
@@ -3170,6 +3171,11 @@ declare type ClearCacheOption = {
      * browser data that can be used across sessions
      */
     localStorage?: boolean;
+    /**
+     * Clears saved window-state data written for windows that use `saveWindowState`.
+     * After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
+     */
+    windowState?: boolean;
 };
 
 /**
@@ -3212,6 +3218,11 @@ declare type ClearDataOptions = {
      * - `origin-in-all-contexts` - Storage is matched on origin only in all contexts.
      */
     originMatchingMode?: 'third-parties-included' | 'origin-in-all-contexts';
+    /**
+     * Clears saved window-state data written for windows that use `saveWindowState`.
+     * After this data is cleared, previously persisted bounds and state (Maximized/Minimized) will not be restored until new state is written again.
+     */
+    windowState?: boolean;
 };
 
 /**
@@ -6709,6 +6720,16 @@ declare type IntentMetadata<TargetType = any> = {
  */
 declare class InterApplicationBus extends Base {
     Channel: Channel;
+    /**
+     * Event types for the InterApplicationBus.
+     *
+     * @remarks The `subscriber-added` and `subscriber-removed` events are disabled by default.
+     * To re-enable them, launch the runtime with the `--emit-legacy-iab-events` flag.
+     * These events will be removed in a future version. Use {@link Channel} for connection
+     * lifecycle management instead.
+     *
+     * @deprecated Use {@link Channel} `onConnection` / `onDisconnection` instead.
+     */
     events: {
         subscriberAdded: string;
         subscriberRemoved: string;
@@ -10623,6 +10644,9 @@ declare namespace OpenFin_2 {
         SystemProcessInfo,
         ClearCacheOption,
         ClearDataOptions,
+        TraceConfig,
+        TraceCategoriesAndOptions,
+        TraceBufferUsage,
         CookieInfo,
         CookieOption,
         CrashReporterOptions,
@@ -13297,19 +13321,17 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         response: OpenFin_2.MenuResult;
     };
     'close-tray-icon-popup-menu': IdentityCall<{}, void>;
-    'wrap-application': VoidCall;
-    'wrap-application-sync': VoidCall;
     'create-application': ApiCall<OpenFin_2.ApplicationCreationOptions, void>;
-    'application-create': VoidCall;
-    'start-application': VoidCall;
     'run-applications': ApiCall<{
         applications: Array<OpenFin_2.ManifestInfo>;
         opts?: OpenFin_2.RvmLaunchOptions;
     }, void>;
-    'get-current-application': VoidCall;
-    'get-current-application-sync': VoidCall;
-    'application-start-from-manifest': VoidCall;
-    'application-create-from-manifest': VoidCall;
+    'send-analytics-batch': {
+        request: {
+            counts: Record<string, number>;
+        };
+        response: void;
+    };
     'request-external-authorization': {
         request: any;
         response: void;
@@ -13428,10 +13450,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         options: OpenFin_2.UpdatableViewOptions;
     }>;
     'trigger-before-unload': IdentityCall<{}, boolean>;
-    'view-wrap-sync': VoidCall;
-    'view-wrap': VoidCall;
-    'view-get-current': VoidCall;
-    'view-get-current-sync': VoidCall;
     'animate-window': IdentityCall<{
         transitions: OpenFin_2.Transition;
         options: OpenFin_2.TransitionOptions;
@@ -13523,11 +13541,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         };
         response: void;
     };
-    'window-wrap': VoidCall;
-    'window-wrap-sync': VoidCall;
-    'create-window': VoidCall;
-    'get-current-window': VoidCall;
-    'get-current-window-sync': VoidCall;
     'show-download-bubble': IdentityCall<{
         anchor?: OpenFin_2.Anchor;
     }, void>;
@@ -13535,14 +13548,8 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         anchor: OpenFin_2.Anchor;
     }, void>;
     'get-external-application-info': ApiCall<OpenFin_2.ApplicationIdentity, OpenFin_2.ExternalApplicationInfo>;
-    'external-application-wrap': VoidCall;
-    'external-application-wrap-sync': VoidCall;
     'get-frame-info': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
     'get-parent-window': ApiCall<OpenFin_2.Identity, OpenFin_2.FrameInfo>;
-    'frame-wrap': VoidCall;
-    'frame-wrap-sync': VoidCall;
-    'frame-get-current': VoidCall;
-    'frame-get-current-sync': VoidCall;
     'global-hotkey-register': {
         request: {
             hotkey: string;
@@ -13635,6 +13642,12 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     }, OpenFin_2.NativeTheme>;
     'get-theme-preferences': GetterCall<OpenFin_2.NativeTheme>;
     'get-version': GetterCall<string>;
+    'content-tracing-get-categories': GetterCall<string[]>;
+    'content-tracing-start-recording': ApiCall<{
+        options: OpenFin_2.TraceConfig | OpenFin_2.TraceCategoriesAndOptions;
+    }, void>;
+    'content-tracing-stop-recording': GetterCall<string>;
+    'content-tracing-get-trace-buffer-usage': GetterCall<OpenFin_2.TraceBufferUsage>;
     'clear-cache': ApiCall<OpenFin_2.ClearCacheOption, void>;
     'clear-http-cache': VoidCall;
     'clear-cache-data': ApiCall<OpenFin_2.ClearDataOptions, void>;
@@ -13879,7 +13892,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         apiPath: '.resolveDomainSettings';
         namespace: 'System';
     };
-    'system-register-shutdown-handler': VoidCall;
     'get-permissions': GetterCall<any>;
     'refresh-extensions': {
         request: void;
@@ -13898,24 +13910,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
         request: void;
         response: Array<OpenFin_2.ThemePalette>;
     };
-    'fdc3-add-context-listener': VoidCall;
-    'fdc3-add-intent-listener': VoidCall;
-    'fdc3-raise-intent': VoidCall;
-    'fdc3-find-intent': VoidCall;
-    'fdc3-find-intents-by-context': VoidCall;
-    'fdc3-raise-intent-for-context': VoidCall;
-    'fdc3-get-info': VoidCall;
-    'fdc3-find-instances': VoidCall;
-    'fdc3-get-app-metadata': VoidCall;
-    'fdc3-broadcast': VoidCall;
-    'fdc3-open': VoidCall;
-    'fdc3-get-or-create-channel': VoidCall;
-    'fdc3-get-system-channels': VoidCall;
-    'fdc3-join-channel': VoidCall;
-    'fdc3-get-current-channel': VoidCall;
-    'fdc3-leave-current-channel': VoidCall;
-    'interop-init': VoidCall;
-    'interop-connect-sync': VoidCall;
     'interop-client-set-context': VoidCall;
     'interop-client-add-context-handler': VoidCall;
     'interop-client-get-context-groups': VoidCall;
@@ -13946,12 +13940,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'interop-session-context-group-set-context': VoidCall;
     'interop-session-context-group-get-context': VoidCall;
     'interop-session-context-group-add-handler': VoidCall;
-    'platform-wrap': VoidCall;
-    'platform-wrap-sync': VoidCall;
-    'platform-get-current': VoidCall;
-    'platform-get-current-sync': VoidCall;
-    'platform-start': VoidCall;
-    'platform-start-from-manifest': VoidCall;
     'platform-get-client': ApplicationIdentityCall<{}, void>;
     'platform-create-view': ApplicationIdentityCall<{}, void>;
     'platform-create-window': ApplicationIdentityCall<{}, void>;
@@ -13964,11 +13952,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'platform-set-window-context': ApplicationIdentityCall<{}, void>;
     'platform-get-window-context': ApplicationIdentityCall<{}, void>;
     'platform-close-window': ApplicationIdentityCall<{}, void>;
-    'layout-wrap': VoidCall;
-    'layout-wrap-sync': VoidCall;
-    'layout-get-current': VoidCall;
-    'layout-get-current-sync': VoidCall;
-    'layout-init': VoidCall;
     'layout-get-config': VoidCall;
     'layout-get-views': VoidCall;
     'layout-replace': VoidCall;
@@ -13987,12 +13970,6 @@ declare type ProtocolMap = ExternalAdapterOnlyCallsMap & AnalyticsProtocolMap &
     'layout-controller-create-adjacent-stack': VoidCall;
     'layout-controller-get-adjacent-stacks': VoidCall;
     'layout-controller-set-stack-active-view': VoidCall;
-    'snapshot-source-init': VoidCall;
-    'snapshot-source-wrap-sync': VoidCall;
-    'snapshot-source-wrap': VoidCall;
-    'snapshot-source-ready': VoidCall;
-    'snapshot-source-get-snapshot': VoidCall;
-    'snapshot-source-apply-snapshot': VoidCall;
     'capture-page': IdentityCall<{
         options?: OpenFin_2.CapturePageOptions;
     }, string>;
@@ -15227,6 +15204,10 @@ declare type SubscriptionOptions = {
  *
  */
 declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
+    /**
+     * Chromium content tracing APIs.
+     */
+    readonly ContentTracing: SystemContentTracing;
     /**
      * @internal
      */
@@ -15253,13 +15234,15 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      * * cookies: browser [cookies](https://developer.mozilla.org/en-US/docs/Web/HTTP/Cookies)
      * * localStorage: browser data that can be used across sessions ([local storage](https://developer.mozilla.org/en-US/docs/Web/API/Window/localStorage))
      * * appcache: html5 [application cache](https://developer.mozilla.org/en-US/docs/Web/HTML/Using_the_application_cache)
+     * * windowState: clears data written for windows using `saveWindowState`; after clearing, previously saved bounds and state will not be restored until new state is written
      * @example
      * ```js
      * const clearCacheOptions = {
      *     appcache: true,
      *     cache: true,
      *     cookies: true,
-     *     localStorage: true
+     *     localStorage: true,
+     *     windowState: true
      * };
      * fin.System.clearCache(clearCacheOptions).then(() => console.log('Cache cleared')).catch(err => console.log(err));
      * ```
@@ -15284,12 +15267,16 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
      *
      * @param options - Optional configuration for what data to clear
      *
+     * @remarks Set `windowState: true` to also clear data written for windows using `saveWindowState`.
+     * After this data is cleared, previously saved bounds and state will not be restored until new state is written again.
+     *
      * @example
      * ```js
      * // Clear only cookies and localStorage for a specific origin
      * await fin.System.clearCacheData({
      *     dataTypes: ['cookies', 'localStorage'],
-     *     origins: ['http://localhost:8081']
+     *     origins: ['http://localhost:8081'],
+     *     windowState: true
      * });
      *
      * // Clear everything except for a specific origin
@@ -16863,6 +16850,36 @@ declare class System extends EmitterBase<OpenFin_2.SystemEvent> {
     getThemePalette(): Promise<Array<OpenFin_2.ThemePalette>>;
 }
 
+/**
+ * Chromium content tracing APIs exposed under `fin.System.ContentTracing`.
+ */
+declare class SystemContentTracing extends Base {
+    /**
+     * Gets the currently known tracing category groups.
+     */
+    getCategories(): Promise<string[]>;
+    /**
+     * Starts content tracing across runtime processes.
+     *
+     * Only one content tracing session may be active across the runtime at a time.
+     * This method rejects if another identity already owns the active session.
+     */
+    startRecording(options: OpenFin_2.TraceConfig | OpenFin_2.TraceCategoriesAndOptions): Promise<void>;
+    /**
+     * Stops the active content tracing session and writes the trace to the runtime-managed cache folder.
+     *
+     * The calling identity must match the identity that started the active tracing session.
+     * This method rejects if tracing is not active or is owned by another identity.
+     */
+    stopRecording(): Promise<string>;
+    /**
+     * Returns the current maximum trace buffer usage across processes.
+     *
+     * This method is not supported on macOS and rejects on that platform.
+     */
+    getTraceBufferUsage(): Promise<OpenFin_2.TraceBufferUsage>;
+}
+
 /**
  * @deprecated Renamed to {@link Event}.
  */
@@ -17309,6 +17326,76 @@ declare type Time = {
 
 declare type TimeZones = 'utc' | 'local';
 
+/**
+ * @interface
+ * Current maximum usage across trace buffers.
+ */
+declare type TraceBufferUsage = {
+    value: number;
+    percentage: number;
+};
+
+/**
+ * @interface
+ * Shorthand tracing configuration based on Electron's contentTracing.startRecording() API.
+ */
+declare type TraceCategoriesAndOptions = {
+    /**
+     * Filter that controls which category groups should be traced.
+     * A filter can have an optional '-' prefix to exclude category groups that contain a matching category. Having both included and excluded category patterns in the same list is not supported. Examples: test_MyTest*, test_MyTest*,test_OtherStuff, -excluded_category1,-excluded_category2.
+     */
+    categoryFilter: string;
+    /**
+     * Comma-delimited string controlling recording mode and extra trace options. valid strings; record-until-full, record-continuously, trace-to-console, enable-sampling, enable-systrace, e.g. 'record-until-full,enable-sampling'. The first 3 options are trace recording modes and hence mutually exclusive. If more than one trace recording modes appear in the traceOptions string, the last one takes precedence. If none of the trace recording modes are specified, recording mode is record-until-full. The trace option will first be reset to the default option (record_mode set to record-until-full, enable_sampling and enable_systrace set to false) before options parsed from traceOptions are applied on it.
+     */
+    traceOptions: string;
+};
+
+/**
+ * @interface
+ * Structured tracing configuration based on Electron's contentTracing.startRecording() API.
+ */
+declare type TraceConfig = {
+    /**
+     * Can be `record-until-full`, `record-continuously`, `record-as-much-as-possible` or `trace-to-console`.
+     * Defaults to `record-until-full`, which will record until the trace buffer is full and then stop recording.
+     */
+    recording_mode?: 'record-until-full' | 'record-continuously' | 'record-as-much-as-possible' | 'trace-to-console';
+    /**
+     * Maximum size of the trace recording buffer in kilobytes.
+     */
+    trace_buffer_size_in_kb?: number;
+    /**
+     * Maximum size of the trace recording buffer in events.
+     * Defaults to 100MB
+     */
+    trace_buffer_size_in_events?: number;
+    /**
+     * Filters event data according to Chromium's vetted allowlist.
+     */
+    enable_argument_filter?: boolean;
+    /**
+     * A list of tracing categories to include.
+     */
+    included_categories?: string[];
+    /**
+     * A list of tracing categories to exclude.
+     */
+    excluded_categories?: string[];
+    /**
+     * A list of process IDs to include in the trace.
+     */
+    included_process_ids?: number[];
+    /**
+     * A list of histogram names to report with the trace.
+     */
+    histogram_names?: string[];
+    /**
+     * Additional configuration for memory tracing when memory-infra tracing is enabled.
+     */
+    memory_dump_config?: Record<string, any>;
+};
+
 /**
  * @interface
  */
@@ -17377,9 +17464,12 @@ declare class Transport<MeType extends EntityType = EntityType> extends EventEmi
     sendRaw: Wire['send'];
     eventAggregator: EventAggregator;
     protected messageHandlers: MessageHandler[];
-    constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity);
+    constructor(factory: WireFactory, environment: Environment, config: OpenFin_2.Identity & {
+        apiDiagnostics?: boolean;
+    });
     getFin(): OpenFin_2.Fin<MeType>;
     registerFin(_fin: OpenFin_2.Fin<MeType>): void;
+    recordAnalytic(action: string): void;
     connectSync: () => void;
     getPort: () => string;
     shutdown(): Promise<void>;