@openfin/workspace 12.6.6 → 13.0.1

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

@@ -1,41 +1,89 @@
 import type OpenFin from '@openfin/core';
-import { ProviderInfo } from '../../../client-api/src/shapes';
-export declare enum ProviderType {
-    Storefront = "storefront",
-    Dock = "dock"
-}
-export interface ProviderIdentity {
+import { RemoveFunctions } from '../../../common/src/utils/types';
+import { DockProvider, StorefrontProvider, WorkspaceButtonsConfig } from '../../../client-api/src/shapes';
+interface WithIdentity {
     /**
-     * The ID of the Provider.
+     * The platform identity that registered the Storefront Provider.
      */
-    id: string;
+    platformIdentity: OpenFin.Identity;
     /**
-     * The platform identity that registered the Provider.
+     * Unique identifier for the provider.
+     * Namespaced by platformIdentity to avoid collisions.
      */
-    platformIdentity: OpenFin.Identity;
-}
-export interface ProviderInfoWithIdentity extends ProviderInfo {
-    platformIdentity: OpenFin.Identity;
+    uniqueId: string;
 }
+export declare type ProviderType = 'storefront' | 'dock';
+/**
+ * The internal representation of the dock provider, which includes the identity of the provider
+ * All functions on the DockProvider type are removed, as they are handled through OpenFin Channels
+ *
+ * The `platformIdentity` is added in the register call [here](../../../provider/src/api/provider.ts)
+ */
+export declare type DockProviderInternal = 
+/**
+ * Remove all functions from the StorefrontProvider type, as they are handled through OpenFin Channels
+ */
+RemoveFunctions<Omit<DockProvider, 'workspaceComponents'>> & {
+    workspaceComponents: WorkspaceButtonsConfig;
+} & WithIdentity;
+/**
+ * The internal representation of the storefront provider, which includes the identity of the provider
+ * All functions on the StorefrontProvider type are removed, as they are handled through OpenFin Channels
+ *
+ * The `platformIdentity` is added in the register call [here](../../../provider/src/api/provider.ts)
+ */
+export declare type StorefrontProviderInternal = 
+/**
+ * Remove all functions from the StorefrontProvider type, as they are handled through OpenFin Channels
+ */
+RemoveFunctions<StorefrontProvider> & WithIdentity;
+/**
+ * The internal representation of a provider, which includes the identity of the provider
+ * This should be used anywhere within 'dock/*' or 'storefront/*' and most places within 'provider/*'
+ * to ensure that the identity is included
+ */
+export declare type ProviderInfoInternal<T extends ProviderType = ProviderType> = T extends 'dock' ? DockProviderInternal : StorefrontProviderInternal;
 export interface ProviderChannelPayload {
     providerType: ProviderType;
 }
-export interface ProviderRegisterPayload extends ProviderChannelPayload {
-    info: ProviderInfo;
-}
+export declare type ProviderRegisterPayload = {
+    providerType: 'dock';
+    info: RemoveFunctions<DockProvider>;
+} | {
+    providerType: 'storefront';
+    info: RemoveFunctions<StorefrontProvider>;
+};
 export interface ProviderDeregisterPayload extends ProviderChannelPayload {
-    id?: string;
-}
-export interface ProviderConnectionPayload extends ProviderChannelPayload {
-    provider: ProviderInfoWithIdentity;
+    id: string;
 }
-export interface ProviderDisconnectionPayload extends ProviderChannelPayload {
-    provider: ProviderInfoWithIdentity;
+export declare type ProviderConnectionPayload = {
+    providerType: 'dock';
+    provider: DockProviderInternal;
+} | {
+    providerType: 'storefront';
+    provider: StorefrontProviderInternal;
+};
+export declare type ProviderDisconnectionPayload = {
+    providerType: 'dock';
+    provider: DockProviderInternal;
+} | {
+    providerType: 'storefront';
+    provider: StorefrontProviderInternal;
+};
+export interface ProviderUpdatePayload {
+    providerType: 'dock';
+    provider: DockProviderInternal;
 }
+/**
+ * Gets a unique identifier for a provider, based on the provider's identity and the provider's id
+ *
+ * This allows for different providers to be registered with the same id.
+ */
+export declare const getUniqueProviderIdentifier: ({ platformIdentity, id }: Pick<ProviderInfoInternal, 'platformIdentity' | 'id'>) => string;
 /**
  * Get a list of all providers that have registered with the provider API.
  */
-export declare const getProviders: (providerType: ProviderType) => Promise<ProviderInfoWithIdentity[]>;
+export declare const getProviders: <T extends ProviderType>(providerType: T) => Promise<ProviderInfoInternal<T>[]>;
 /**
  * A function to dispatch showing the component window of current OF identity
  * @returns action to show Component Window
@@ -46,3 +94,4 @@ export declare const showProviderWindow: (providerType: ProviderType) => Promise
  * @returns action to hide Component Window
  */
 export declare const hideProviderWindow: (providerType: ProviderType) => Promise<void>;
+export {};

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

@@ -16,5 +16,5 @@ export interface SearchItem {
     requestReload?: () => any;
 }
 export declare type Topic = typeof homeSearchTopic;
-export declare function getTopic(topic: Topic): Promise<SearchTopicClient>;
+export declare function getHomeSearchTopic(): Promise<SearchTopicClient>;
 export declare function mapSearchResponsesToItems(topic: Topic, responses: SearchProviderResponse[]): SearchItem[];

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

@@ -1,26 +1,9 @@
-import type OpenFin from '@openfin/core';
-import { App, StorefrontFooter, StorefrontLandingPage, StorefrontNavigationItemAppGrid, StorefrontNavigationSection, StorefrontProviderInfo } from '../../../client-api/src/shapes';
-export interface StorefrontProviderInfoWithIdentity extends StorefrontProviderInfo {
-    platformIdentity: OpenFin.Identity;
-}
-export interface LaunchStorefrontAppRequest {
-    app: App;
-    platformIdentity?: OpenFin.Identity;
-}
-export interface StorefrontProviderIdentity {
-    /**
-     * The ID of the Storefront Provider.
-     */
-    id: string;
-    /**
-     * The platform identity that registered the Storefront Provider.
-     */
-    platformIdentity: OpenFin.Identity;
-}
+import { App, StorefrontFooter, StorefrontLandingPage, StorefrontNavigationItemAppGrid, StorefrontNavigationSection } from '../../../client-api/src/shapes';
+import { ProviderInfoInternal } from './provider';
 /**
  * Request object to launch an app.
  */
-export interface LaunchStorefrontProviderAppRequest extends StorefrontProviderIdentity {
+export interface LaunchStorefrontProviderAppRequest extends ProviderInfoInternal<'storefront'> {
     /**
      * App to launch.
      */
@@ -36,29 +19,29 @@ export declare const launchStorefrontApp: (req: LaunchStorefrontProviderAppReque
  * @param identity of the platform to get the apps from.
  * @returns the list of Storefront apps for the platform.
  */
-export declare const getStorefrontApps: (identity: StorefrontProviderIdentity) => Promise<App[]>;
+export declare const getStorefrontApps: (provider: ProviderInfoInternal<'storefront'>) => Promise<App[]>;
 /**
  * Get the platform's landing page for Storefront.
  * @param identity of the platform to get the landing page of.
  * @returns the platform's landing page.
  */
-export declare const getStorefrontLandingPage: (identity: StorefrontProviderIdentity) => Promise<StorefrontLandingPage | undefined>;
+export declare const getStorefrontLandingPage: (provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontLandingPage | undefined>;
 /**
  * Get the platform's footer for Storefront.
  * @param identity of the platform to get the footer of.
  * @returns the platform's footer.
  */
-export declare const getStorefrontFooter: (identity: StorefrontProviderIdentity) => Promise<StorefrontFooter>;
+export declare const getStorefrontFooter: (provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontFooter>;
 /**
  * Get the platform's navigation for Storefront.
  * @param identity of the platform to get the navigation of.
  * @returns the platform's navigation.
  */
-export declare const getStorefrontNavigation: (identity: StorefrontProviderIdentity) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
+export declare const getStorefrontNavigation: (provider: ProviderInfoInternal<'storefront'>) => Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
 /**
  * A helper method that gets a Storefront navigation item by ID.
  * @param navigationItemId the id of the Storefront navigation item.
  * @param identity of the platform.
  * @returns the navigation item with the ID.
  */
-export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, identity: StorefrontProviderIdentity) => Promise<StorefrontNavigationItemAppGrid | undefined>;
+export declare const getStorefrontNavigationItemAppGrid: (navigationItemId: string, provider: ProviderInfoInternal<'storefront'>) => Promise<StorefrontNavigationItemAppGrid | undefined>;

package/common/src/utils/create-and-migrate-ibd-store.d.ts

@@ -1,2 +1,3 @@
 import { UseStore } from 'idb-keyval';
+export declare const createNamespacedStore: (storeName: string, tableName: string) => UseStore;
 export declare const getNewStoreAndMigrateLegacyStore: (storeName: string, tableName: string) => UseStore;

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

@@ -24,3 +24,4 @@ export declare const workspaceDocsPlatformUrl: string;
 export declare const workspaceDocsClientUrl: string;
 export declare const workspaceRuntimeVersion: string;
 export declare const workspaceBuildVersion: string;
+export declare const workspaceBuildSha: string;

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

@@ -1,13 +1,19 @@
 import type OpenFin from '@openfin/core';
 import { AttachedPage, PageLayout } from '../../../client-api-platform/src/shapes';
 import { WindowIdentity } from './window';
-export declare enum LayoutDOMEventType {
-    TabCreated = "tab-created",
-    ContainerCreated = "container-created",
-    ContainerResized = "container-resized"
-}
-export interface LayoutDOMEvent {
-    type: LayoutDOMEventType;
+export declare type LayoutDOMEventType = 
+/**
+ * Fired when a tab is created in a container. (Emmitted by core)
+ */
+'tab-created'
+/**
+ * Fired when the layout container is ready to be used. (Emitted by us)
+ */
+ | 'container-resized';
+export declare type LayoutDOMEvent = {
+    type: Extract<LayoutDOMEventType, 'container-resized'>;
+} | {
+    type: Extract<LayoutDOMEventType, 'tab-created'>;
     detail: {
         containerSelector: string;
         tabSelector: string;
@@ -17,7 +23,7 @@ export interface LayoutDOMEvent {
         uuid: string;
     };
     isInitialized: boolean;
-}
+};
 export declare type LayoutDOMEventListener = (ev: LayoutDOMEvent) => void;
 export declare const getFirstViewFromLayout: (identity?: WindowIdentity) => Promise<{
     name: any;
@@ -30,9 +36,15 @@ export declare const getFirstViewFromLayout: (identity?: WindowIdentity) => Prom
  */
 export declare const generateViewNameIfNotExists: <T extends {
     name?: string;
-}>(componentState: T) => T & {
+}>(componentState: T) => Omit<T, "name"> & {
     name: string;
 };
+export declare const generateViewNameAndIdentifierNameIfNotExists: <T extends {
+    name?: string;
+    _internalWorkspaceData: any;
+}>(componentState: T) => T & {
+    name?: string;
+};
 /**
  * Deep clones a layout and adds view names if they don't exist.
  * @param layout The Layout to be cloned
@@ -66,7 +78,7 @@ export declare const getLockedPageLayout: (layout: PageLayout) => any;
 /**
  * Accepts a locked layout and an unlocked layout as a reference.
  * Takes the layout settings of the reference layout and merges them into the locked layout, thereby unlocking it.
- * @param lockedLayout The Layout to unlocke
+ * @param lockedLayout The Layout to unlock
  * @param referenceUnlockedLayout The Layout to serve as a reference of an unlocked layout
  * @returns An unlocked version of the target layout
  */

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

@@ -8,7 +8,6 @@ export declare enum PageRoute {
     HomeSearch = "/home/?deeplink=search",
     HomePagesRename = "/home/pages/rename/",
     Dock = "/dock/",
-    BrowserPagesLanding = "/browser/pages/landing/",
     HomeIndicator = "/home/indicator/",
     Browser = "/browser/",
     BrowserPopupMenu = "/browser/popup-menu/",
@@ -44,7 +43,6 @@ declare const _default: {
     HomeSearch: PageRoute.HomeSearch;
     HomePagesRename: PageRoute.HomePagesRename;
     Dock: PageRoute.Dock;
-    BrowserPagesLanding: PageRoute.BrowserPagesLanding;
     HomeIndicator: PageRoute.HomeIndicator;
     Browser: PageRoute.Browser;
     BrowserPopupMenu: PageRoute.BrowserPopupMenu;

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

@@ -4,3 +4,25 @@ export declare type StringMap<T> = {
 };
 export declare type Await<T> = T extends PromiseLike<infer U> ? U : T;
 export declare type ValueOf<T> = T[keyof T];
+/**
+ * This is a helper type that takes a type T and returns a type that is the same as T, but with all
+ * properties that are functions removed.
+ *
+ * @example
+ * ```ts
+ * type Foo = {
+ *     bar: string;
+ *     qux: () => void;
+ * }
+ *
+ * type FooWithoutFunctions = RemoveFunctions<Foo>;
+ *
+ * // FooWithoutFunctions is equivalent to:
+ * type FooWithoutFunctions = {
+ *     bar: string;
+ * }
+ * ```
+ */
+export declare type RemoveFunctions<T> = Pick<T, {
+    [K in keyof T]: T[K] extends Function ? never : K;
+}[keyof T]>;

package/common/src/utils/unique-toolbar-options.d.ts

@@ -1,2 +1,2 @@
 import { ToolbarButton } from '../../../client-api-platform/src/shapes';
-export declare const checkUniqueToolbarOptions: (toolbarOptions: ToolbarButton[]) => void;
+export declare const checkUniqueToolbarOptions: (toolbarOptions?: ToolbarButton[]) => void;

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

@@ -134,7 +134,6 @@ export declare const isWindowRunning: (identity: WindowIdentity) => Promise<bool
  */
 export declare const isStorefrontWindowRunning: () => Promise<boolean>;
 export declare const isDockWindowRunning: () => Promise<boolean>;
-export declare const isNotificationCenterRunning: () => Promise<boolean>;
 export declare const isHomeWindowRunning: () => Promise<boolean>;
 export declare const showAndFocusStorefront: () => Promise<void>;
 export declare const showAndFocusDock: () => Promise<void>;
@@ -144,6 +143,5 @@ export declare const getPlatformWindowTitle: (identity: WindowIdentity) => Promi
 export declare const getComponentWindowStatus: () => Promise<{
     storefrontRunning: boolean;
     homeRunning: boolean;
-    notificationCenterRunning: boolean;
 }>;
 export {};