@openfin/workspace-platform 12.4.0 → 12.6.0

package/client-api-platform/src/api/analytics.d.ts

@@ -1,4 +1,4 @@
-import { AnalyticsEvent } from '../../../common/src/utils/usage-register';
+import { AnalyticsEventInternal } from '../../../common/src/utils/usage-register';
 import { AnalyticsConfig, WorkspacePlatformProvider } from '../../../client-api-platform/src/shapes';
 declare global {
     interface Window {
@@ -9,5 +9,5 @@ declare global {
         };
     }
 }
-export declare function analyticsInternal(this: WorkspacePlatformProvider, events: AnalyticsEvent[]): Promise<void>;
+export declare function analyticsInternal(this: WorkspacePlatformProvider, events: AnalyticsEventInternal[]): Promise<void>;
 export declare const initPlatformAnalytics: (config?: AnalyticsConfig) => Promise<void>;

package/client-api-platform/src/api/pages/page-analytics.d.ts

@@ -0,0 +1,5 @@
+import { AnalyticsEventInternal } from '../../../../common/src/utils/usage-register';
+import { Page } from '../../../../client-api-platform/src/shapes';
+export declare const addOpenPageToCache: (pageId: Page['pageId'], event: AnalyticsEventInternal) => Map<string, AnalyticsEventInternal>;
+export declare const removeOpenPageFromCache: (pageId: Page['pageId']) => boolean;
+export declare const raiseMissedPageCloseEvents: () => Promise<void>;

package/client-api-platform/src/api/utils.d.ts

@@ -1 +1,2 @@
 export declare const handleNameCollision: (initialName: string, existingNames: string[]) => string;
+export declare const listenForStoreClose: () => void;

package/client-api-platform/src/api/workspaces/index.d.ts

@@ -20,7 +20,7 @@ export declare function getInitialWorkspace(): Promise<Workspace>;
  * @returns the current active workspace.
  */
 export declare function getCurrentWorkspace(): Promise<Workspace>;
-export declare function getLastSavedWorkspace(): Promise<Workspace>;
+export declare function getLastSavedWorkspace(): Promise<Workspace | undefined>;
 export declare const createWorkspaceInStorage: (req: CreateSavedWorkspaceRequest) => Promise<any>;
 export declare const getWorkspacesInStorage: () => Promise<Workspace[]>;
 export declare const getWorkspaceInStorage: (id: string) => Promise<Workspace>;

package/client-api-platform/src/shapes.d.ts

@@ -1,6 +1,6 @@
 import type OpenFin from '@openfin/core';
 import { IconProps } from '@openfin/ui-library';
-import type { AnalyticsEvent } from '../../common/src/utils/usage-register';
+import type { AnalyticsEvent, AnalyticsEventInternal } from '../../common/src/utils/usage-register';
 import { CustomActionSpecifier, CustomButtonConfig } from '../../common/src/api/action';
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
@@ -1131,12 +1131,32 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      */
     setActiveWorkspace(workspace: Workspace): Promise<void>;
     /**
-     * Closes content from the current workspace and applies the given workspace to the user's desktop.  Makes that
-     * workspace the active workspace.
+     * Applies the given workspace to the user's desktop.  Makes that workspace the active workspace.
+     *
      * @param workspace the workspace to apply to the desktop and set as the current active workspace.
      * @param options see {@link ApplyWorkspaceOptions}.
      *
      * @returns true if the workspace was applied, false if the workspace was not applied.
+     *
+     * @example Brief example of how to apply a workspace, currently stored in storage, to the desktop.
+     *
+     * ```ts
+     * const workspacePlatform = getCurrentSync();
+
+     * // This assumes that there is at least one workspace in storage.
+     * const allWorkspaces = await workspacePlatform.Storage.getWorkspaces();
+     *
+     * // Apply the first workspace in storage to the desktop.
+     * await workspacePlatform.applyWorkspace(allWorkspaces[0], {
+     *     // Customize the behavior of the applyWorkspace call.
+     *     skipPrompt: false,
+     *     applySnapshotOptions: {
+     *       closeExistingWindows: false,
+     *       closeSnapshotWindows: false,
+     *       skipOutOfBoundsCheck: false,
+     *     },
+     * });
+     * ```
      */
     applyWorkspace(workspace: Workspace, options?: ApplyWorkspaceOptions): Promise<boolean>;
     /**
@@ -1151,7 +1171,7 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * Theme API for the Workspace Platform.
      */
     Theme: ThemeApi;
-    _raiseAnalytics(events: AnalyticsEvent[]): Promise<void>;
+    _raiseAnalytics(events: AnalyticsEventInternal[]): Promise<void>;
 }
 export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
     /**
@@ -1289,17 +1309,23 @@ export interface ApplyWorkspaceOptions {
      */
     promptContainerWindowIdentity?: OpenFin.Identity;
     /**
-     * @inheritdoc OpenFin.ApplySnapshotOptions
+     * Options to apply the workspace spanshot with.
      */
-    applySnapshotOptions?: OpenFin.ApplySnapshotOptions & {
-        /**
-         * When true, applyWorkspace will close all existing windows,
-         * replacing current Platform state with the given snapshot.
-         *
-         * @default true
-         */
-        closeExistingWindows?: boolean;
-    };
+    applySnapshotOptions?: ApplySnapshotOptions;
+}
+/**
+ * Options used within the {@link WorkspacePlatformModule.applyWorkspace applyWorkspace} method.
+ *
+ * @inheritdoc OpenFin.ApplySnapshotOptions
+ */
+export interface ApplySnapshotOptions extends OpenFin.ApplySnapshotOptions {
+    /**
+     * When true, applyWorkspace will close all existing windows,
+     * replacing current Platform state with the given snapshot.
+     *
+     * @default true
+     */
+    closeExistingWindows?: boolean;
 }
 /**
  * Payload received by applyWorkspace platform provider method

package/common/src/api/overrides.d.ts

@@ -15,6 +15,7 @@ export interface Overrides {
     };
     disableRuntimeValidation: boolean;
     disableOpenFinAnalytics: boolean;
+    analyticsEndpoint: string;
 }
 export declare function getOverrides(): Promise<Partial<Overrides>>;
 export declare const useOverrides: () => Partial<Overrides>;

package/common/src/utils/analytics.d.ts

@@ -0,0 +1,23 @@
+import { AnalyticsEventInternal } from './usage-register';
+export declare const generateHash: (text: string) => Promise<string>;
+interface AnalyticsBackendPayload {
+    d: {
+        app_config: string;
+        app_name: string;
+        app_uuid: string;
+        clientId: string;
+        combined_id: string;
+        content_url: string;
+        machine_id: string;
+        manifest_type: 'platform';
+        os: string;
+        runtime_version: string;
+        rvm_version: string;
+        type: 'workspace-analytics';
+        u: string;
+        data: AnalyticsEventInternal;
+        timestamp: string;
+    };
+}
+export declare const decorateAnalyticsPayload: (event: AnalyticsEventInternal) => Promise<AnalyticsBackendPayload>;
+export {};

package/common/src/utils/route.d.ts

@@ -21,7 +21,8 @@ export declare enum PageRoute {
     ResponseModal = "/browser/popup-menu/response-modal/",
     Docs = "/provider/docs/",
     Storefront = "/storefront/",
-    DeprecatedAlert = "/provider/deprecated-alert/"
+    DeprecatedAlert = "/provider/deprecated-alert/",
+    Analytics = "/provider/analytics/"
 }
 /**
  * All routes that serve assets. (icons, json, etc.)
@@ -57,6 +58,7 @@ declare const _default: {
     Docs: PageRoute.Docs;
     Storefront: PageRoute.Storefront;
     DeprecatedAlert: PageRoute.DeprecatedAlert;
+    Analytics: PageRoute.Analytics;
     IconOpenFinLogo: AssetRoute.IconOpenFinLogo;
     IconFilter: AssetRoute.IconFilter;
     LightStorefront: AssetRoute.LightStorefront;

package/common/src/utils/usage-register.d.ts

@@ -43,10 +43,17 @@ export declare type AnalyticsEvent = {
     entityId?: OpenFin.Identity;
     data?: any;
 };
-export declare type AnalyticsEventInternal = Omit<AnalyticsEvent, 'source'>;
-export declare const raiseBrowserAnalytics: (payload: AnalyticsEventInternal) => Promise<void>;
+export interface AnalyticsEventInternal extends AnalyticsEvent {
+    /**
+     * By default, all event values are redacted before sending to OF.
+     * For events not containing any identifiable information, set this to true.
+     */
+    skipValueHashing?: boolean;
+}
+export declare type AnalyticsEventRaise = Omit<AnalyticsEventInternal, 'source'>;
+export declare const raiseBrowserAnalytics: (payload: AnalyticsEventRaise) => Promise<void>;
 export declare const raiseBrowserPageAnalytics: (pages: AttachedPage[], action: string) => Promise<void>;
-export declare const raiseHomeAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventInternal) => Promise<void>;
-export declare const raiseDockAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventInternal) => Promise<void>;
-export declare const raiseStorefrontAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventInternal) => Promise<void>;
-export declare const raiseInteropAnalytics: (payload: AnalyticsEventInternal) => Promise<void>;
+export declare const raiseHomeAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;
+export declare const raiseDockAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;
+export declare const raiseStorefrontAnalytics: (platformIdentity: OpenFin.Identity, payload: AnalyticsEventRaise) => Promise<void>;
+export declare const raiseInteropAnalytics: (payload: AnalyticsEventRaise) => Promise<void>;