@openfin/workspace-platform 22.2.18 → 22.3.1

package/dock3/src/api/idb.d.ts

@@ -0,0 +1,3 @@
+import { Dock3Config } from '../../../client-api-platform/src/shapes';
+export declare function getDock3ProviderConfig(): Promise<Dock3Config | undefined>;
+export declare function saveDock3ProviderConfig(config: Dock3Config): Promise<void>;

package/dock3/src/api/index.d.ts

@@ -0,0 +1,14 @@
+import { Dock3Config, DockAllowedWindowOptions } from '../../../dock3/src/shapes';
+import { Dock3ConstructorOverride, Dock3Provider } from './provider';
+export type DockInitOptions = {
+    config: Dock3Config;
+    override: Dock3ConstructorOverride;
+    windowOptions?: DockAllowedWindowOptions;
+};
+/**
+ *
+ * @param config Dock3 configuration object
+ * @param override Constructor override to customize the Dock3Provider
+ * @returns instance of Dock3Provider
+ */
+export declare function init(options: DockInitOptions): Promise<Dock3Provider>;

package/dock3/src/api/launch.d.ts

@@ -0,0 +1,3 @@
+import type { CompanionDockConfig } from '../shapes/enterprise';
+import type { Dock3Config, DockAllowedWindowOptions } from '../shapes/shapes';
+export declare function launchDock(dockName: string, baseUrl: string, config: CompanionDockConfig | Dock3Config, additionalOptions?: DockAllowedWindowOptions): Promise<void>;

package/dock3/src/api/protocol.d.ts

@@ -0,0 +1 @@
+export {};

package/dock3/src/api/provider.d.ts

@@ -0,0 +1,89 @@
+import type { OpenFin } from '@openfin/core';
+import { BookmarkDockEntryPayload, LaunchDockEntryPayload } from '../../../client-api-platform/src/index';
+import { Dock3Config } from '../../../dock3/src/shapes';
+import { Async, CamelCase } from '../../../dock3/src/utils';
+import { Dock3ChannelProvider, Dock3ChannelProviderChannelActions } from './protocol';
+type InternalDock3ChannelActions = 'ready';
+type Dock3ProviderAPI = {
+    [K in keyof Omit<Dock3ChannelProviderChannelActions, InternalDock3ChannelActions> as CamelCase<K>]: Async<Dock3ChannelProviderChannelActions[K]>;
+};
+type ExtendsProtocolProvider<T extends Dock3ProviderAPI> = T extends Dock3ProviderAPI ? T : never;
+export type EnsureProviderMatchesProtocol = ExtendsProtocolProvider<Dock3Provider>;
+export declare class Dock3Provider {
+    #private;
+    static getOverrideConstructor(...args: ConstructorParameters<typeof Dock3Provider>): new () => Dock3Provider;
+    static instance: Dock3Provider | null;
+    constructor(config: Dock3Config, channel: Dock3ChannelProvider);
+    launchEntry(payload: LaunchDockEntryPayload): Promise<void>;
+    /**
+     * Returns a promise that resolves when the Dock3Provider is ready.
+     * This is useful to ensure that the dock is fully initialized before performing any operations.
+     * The promise will resolve when the dock sends the 'ready' action.
+     */
+    get ready(): Promise<void>;
+    bookmarkContentMenuEntry(payload: BookmarkDockEntryPayload): Promise<void>;
+    /**
+     * Read-only access to the current configuration of the Dock3Provider.
+     */
+    get config(): Dock3Config;
+    /**
+     * Protected setter for the configuration of the Dock3Provider.
+     * This does not save the configuration in storage nor notify the dock about the change.
+     * Use `updateConfig` method to update the configuration and save it.
+     * This should only be used internally in a `saveConfig` override if `super.saveConfig` is not called.
+     */
+    protected set config(newConfig: Dock3Config);
+    /**
+     * Updates the configuration of the Dock3Provider.
+     * This method updates the configuration, notifies the dock about the change and saves the new configuration to storage (via `saveConfig`).
+     * @param newConfig The new configuration to be applied.
+     */
+    updateConfig(config: Dock3Config): Promise<void>;
+    /**
+     * Shuts down the Dock3Provider and closes the dock window.
+     * This method sends a shutdown message to the dock and then closes the window.
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Called whenever the configuration is updated, this method saves the configuration to the storage.
+     * This should not be called directly, if you need to update the configuration, use `updateConfig` method instead.
+     */
+    saveConfig({ config }: {
+        config: Dock3Config;
+    }): Promise<void>;
+    private handleConfigChange;
+    /**
+     * Called on startup to load the current configuration of the Dock3Provider.
+     * If you've overridden the `saveConfig` method, this should load the configuration from your storage.
+     * By default it will load the configuration from local storage. This can  be overriden to prevent loading from local storage.
+     * @example Prevent loading from local storage:
+     * ```typescript
+     * class MyDock3Provider extends Dock3Provider {
+     *    async loadConfig(): Promise<Dock3Config> {
+     *       // Do not load from local storage, return the default config
+     *       return this.config;
+     *   }
+     *  }
+     * ```
+     * @example Load from a custom storage:
+     * ```typescript
+     * class MyDock3Provider extends Dock3Provider {
+     *   async loadConfig(): Promise<Dock3Config> {
+     *      // Load from a custom storage
+     *      const configFromStorage = await myCustomStorage.getDockConfig();
+     *      // Update local config to ensure it is used.
+     *      if (configFromStorage) {
+     *         this.config = configFromStorage;
+     *      }
+     *      return this.config;
+     *   }
+     * }
+     * ```
+     * @returns The current configuration of the Dock3Provider.
+     */
+    loadConfig(): Promise<Dock3Config>;
+    getWindowSync(): OpenFin.Window;
+    private registerChannelActions;
+}
+export type Dock3ConstructorOverride = (Base: new () => Dock3Provider) => new () => Dock3Provider;
+export {};

package/dock3/src/shapes/enterprise.d.ts

@@ -0,0 +1 @@
+export type { EnterpriseDockChannelClient, EnterpriseDockChannelProvider } from '../api/protocol';

package/dock3/src/shapes/index.d.ts

@@ -0,0 +1,2 @@
+export * from './shapes';
+export * from './enterprise';

package/dock3/src/shapes/shapes.d.ts

@@ -0,0 +1,63 @@
+import type { OpenFin } from '@openfin/core';
+import { WorkspaceButton } from '../../../client-api/src/dock';
+import { ContentMenuEntry, DockEntry, TaskbarIcon } from '../../../client-api-platform/src/shapes';
+export type { Dock3Provider, Dock3ConstructorOverride } from '../api/provider';
+export type Dock3Button = WorkspaceButton | 'contentMenu';
+/**
+ * Configuration for the Dock 3.0 provider.
+ */
+export interface Dock3Config {
+    title?: string;
+    /**
+     * icon URL for the dock provider.
+     */
+    icon?: string | TaskbarIcon;
+    /**
+     * Favorites to be displayed in the dock
+     */
+    favorites?: DockEntry[];
+    /**
+     * Content menu entries to be displayed in the dock
+     */
+    contentMenu?: ContentMenuEntry[];
+    /**
+     * The config for the default dock buttons
+     */
+    defaultDockButtons?: Dock3Button[];
+    /**
+     * The id of the target element for the content menu.
+     */
+    contentMenuTargetId?: string;
+    /**
+     * The config for the companion dock ui
+     */
+    uiConfig?: {
+        contentMenu?: {
+            enableBookmarking?: boolean;
+        };
+        /**
+         * By default drag handle is visible. Set this to true to hide the drag handle
+         */
+        hideDragHandle?: boolean;
+        /**
+         * By default provider icon is just a drag region. Set this to true to convert it to content menu dropdown button.
+         */
+        providerIconContentMenu?: boolean;
+        /**
+         * Configuration for the dock more menu component.
+         */
+        moreMenu?: {
+            quitPlatform?: {
+                /**
+                 * By default the quit button will contain platform title in its label. Set this to true to hide the platform title.
+                 */
+                hidePlatformTitle?: boolean;
+                /**
+                 * By default the quit button will show a quit confirmation dialog. Set this to true to skip the quit confirmation dialog.
+                 */
+                skipDialog?: boolean;
+            };
+        };
+    };
+}
+export type DockAllowedWindowOptions = Partial<Pick<OpenFin.PlatformWindowOptions, 'defaultCentered' | 'saveWindowState' | 'taskbarIconGroup' | 'defaultTop' | 'defaultLeft'>>;

package/dock3/src/utils.d.ts

@@ -0,0 +1,2 @@
+export type CamelCase<T extends string> = T extends `${infer Head}-${infer Tail}` ? `${Head}${Capitalize<CamelCase<Tail>>}` : T;
+export type Async<T extends (...args: any[]) => any> = T extends (...args: infer P) => infer R ? (...args: P) => Promise<Awaited<R>> : never;

package/externals.report.json

@@ -38,6 +38,12 @@
         }
     ],
     "dexie": [
+        {
+            "type": "root-implicit",
+            "version": "^4.0.11",
+            "packageName": "dock3/package.json",
+            "issuer": "dock3/src/api/idb.ts"
+        },
         {
             "type": "explicit",
             "version": "^4.0.11",