@openfin/workspace 13.0.7 → 13.1.0

package/common/src/utils/router/base.d.ts

@@ -1,4 +1,4 @@
-import type { AssetRoute, PageRoute } from '../route';
+import type { PageRoute } from '../route';
 /**
  * Multiple different Next projects can be merged together into one using zones.
  * This is the path prefix to a single one of those deployed projects.
@@ -21,7 +21,7 @@ export declare function getBasePathWithoutZone(): string;
  * Get the router path to assets like images, json, svg, etc.
  * @returns the path to the
  */
-export declare function getAssetPath(route: AssetRoute | string): string;
+export declare function getAssetPath(route: string): string;
 /**
  * Gets the route without the zone prefix.
  * @param route the route to remove the zone prefix from.

package/common/src/utils/shared-emitter.d.ts

@@ -1,10 +1,11 @@
-export declare type Listener = (...args: any[]) => void;
 /**
  * Creates an event emitter that is shared between all windows within the same domain.
  */
-export default function makeSharedEmitter<E extends string | number, L extends Listener>(id: string): {
-    emit: (event: E, ...payload: any[]) => Promise<void>;
-    addListener: (event: E, listener: L) => void;
-    removeListener: (event: E, listener: L) => void;
-    once: (event: E, listener: L) => void;
+export default function makeSharedEmitter<EventMap extends {
+    [key: string | number]: any[];
+}>(id: string): {
+    emit: <EventKey extends keyof EventMap>(event: EventKey, ...payload: EventMap[EventKey]) => Promise<void>;
+    addListener: <EventKey_1 extends keyof EventMap>(event: EventKey_1, listener: (...payload: EventMap[EventKey_1]) => void) => void;
+    removeListener: <EventKey_2 extends keyof EventMap>(event: EventKey_2, listener: (...payload: EventMap[EventKey_2]) => void) => void;
+    once: <EventKey_3 extends keyof EventMap>(event: EventKey_3, listener: (...payload: EventMap[EventKey_3]) => void) => void;
 };

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

@@ -4,6 +4,13 @@ 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];
+export declare type DeepPartial<T> = T extends object ? {
+    [P in keyof T]?: DeepPartial<T[P]>;
+} : T;
+/**
+ A union type that represents a value that can be directly awaited or a promise that will eventually resolve to a value of type T.
+ */
+export declare type Awaitable<T> = Awaited<T> | Promise<Awaited<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.

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

@@ -13,7 +13,8 @@ export declare enum ComponentName {
     Notification = "Notification",
     Storefront = "Storefront",
     Platform = "Platform",
-    Theming = "Theming"
+    Theming = "Theming",
+    Microflow = "Microflow"
 }
 export declare const registerBrowserUsage: (status: RegisterUsageStatus) => void;
 export declare const registerHomeUsage: (status: RegisterUsageStatus) => void;
@@ -22,6 +23,7 @@ export declare const registerDockUsage: (status: RegisterUsageStatus) => void;
 export declare const registerNotificationUsage: (status: RegisterUsageStatus) => void;
 export declare const registerPlatformUsage: (status: RegisterUsageStatus) => void;
 export declare const registerThemingUsage: (status: RegisterUsageStatus) => void;
+export declare const registerMicroflowUsage: (microflowName: string, status: RegisterUsageStatus) => void;
 export declare enum AnalyticsSource {
     Browser = "Browser",
     Dock = "Dock",

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

@@ -56,22 +56,35 @@ export declare const getBoundsFromCenter: (center: Point, size: Size) => OpenFin
  * @returns the wrapped OpenFin window identity.
  */
 export declare function getOFWindow(identity: WindowIdentity): OpenFin.Window;
-/**
- * The OpenFin identity for the current window.
- */
+/** The OpenFin identity for the current window. */
 export declare const currentOFIdentity: WindowIdentity;
-/**
- * Get the current OpenFin window.
- */
+/** Get the current OpenFin window. */
 export declare function getCurrentOFWindow(): OpenFin.Window;
-/**
- * The OpenFin identity for Home.
- */
-export declare const homeOFIdentity: WindowIdentity;
-export declare const dockOFIdentity: WindowIdentity;
-export declare const notificationCenterOFIdentity: WindowIdentity;
-export declare const storefrontOFIdentity: WindowIdentity;
-export declare const providerOFIdentity: WindowIdentity;
+/** The OpenFin identity for the Home window. */
+export declare const homeOFIdentity: {
+    readonly name: WindowName.Home;
+    readonly uuid: ApplicationUUID.Workspace;
+};
+/** The OpenFin identity for the Dock window. */
+export declare const dockOFIdentity: {
+    readonly name: WindowName.Dock;
+    readonly uuid: ApplicationUUID.Workspace;
+};
+/** The OpenFin identity for the Notification Center window. */
+export declare const notificationCenterOFIdentity: {
+    readonly name: "Notification-Center";
+    readonly uuid: "notifications-service";
+};
+/** The OpenFin identity for the Storefront window. */
+export declare const storefrontOFIdentity: {
+    readonly name: WindowName.Storefront;
+    readonly uuid: ApplicationUUID.Workspace;
+};
+/** The OpenFin identity for the Provider window. */
+export declare const providerOFIdentity: {
+    readonly name: ApplicationUUID.Workspace;
+    readonly uuid: ApplicationUUID.Workspace;
+};
 /**
  * Get the Home OpenFin window.
  */