@openfin/workspace-platform 12.6.1 → 12.6.3

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

@@ -3,7 +3,6 @@
  * up the packaged typing files. When writing code examples,
  * for documentation, please use async/await syntax over .then()!
  */
-import { UpdateButtonConfigRequest } from '../../../client-api/src/store';
 import { CustomButtonConfig, RegistrationMetaInfo } from './common';
 import { ProviderInfo } from './provider';
 /**
@@ -226,6 +225,11 @@ export interface StorefrontNavigationItemAppGrid extends StorefrontNavigationIte
      */
     templateData: StorefrontAppGrid;
 }
+export interface UpdateButtonConfigRequest {
+    appId: string;
+    primaryButton: StoreButtonConfig;
+    secondaryButtons: StoreButtonConfig[];
+}
 /**
  * Response from store registration which includes metadata and a function to update app cards buttons.
  */
@@ -482,99 +486,3 @@ export interface StorefrontProvider extends StorefrontProviderInfo {
      */
     launchApp(app: App): Promise<void>;
 }
-/**
- * Interface that contains functions for integrating with Storefront.
- */
-export interface StorefrontAPI {
-    /**
-   * Registers a [[`StorefrontProvider`]]. Upon registering a provider,
-   * the title of your provider appears in the menu of the Storefront UI.
-   * When a user selects your Storefront, the methods on the provider
-   * object are called to populate the UI. Throws an error if a provider with
-   * the same `id` already exists.
-   *
-   * ```ts
-   * import { Storefront, StorefrontProvider } from "@openfin/workspace";
-   *
-   * //Declare a provider
-   * const myStorefrontProvider: StorefrontProvider = {
-   *      id: "my-storefront-id"
-   *      title: "My StorefrontProvider"
-   *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
-   *      getApps: () => {...},
-   *      getNavigation: () => {...},
-   *      getLandingPage: () => {...},
-   *      getFooter: () => {...},
-   *      launchApp: () => {...}
-   * };
-   *
-   * const registerProvider = async () => {
-   *      await Storefront.register(myStorefrontProvider);
-   * }
-   * ```
-   * @param provider the implementation of a Storefront provider.
-
-   */
-    register(provider: StorefrontProvider): Promise<RegistrationMetaInfo>;
-    /**
-     * Deregister a [[StorefrontProvider]].
-     *
-     * ```ts
-     * import { Storefront, StorefrontProvider } from "@openfin/workspace";
-     *
-     * //Instantiate a StorefrontProvider
-     * const myStorefrontProvider: StorefrontProvider = {
-     *      id: "my-storefront-id"
-     *      title: "My StoreFrontProvider"
-     *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
-     *      getApps: () => {...},
-     *      getNavigation: () => {...},
-     *      getLandingPage: () => {...},
-     *      getFooter: () => {...},
-     *      launchApp: () => {...}
-     * };
-     *
-     * const register = async () => {
-     *      await Storefront.register(myStorefrontProvider);
-     * }
-     *
-     * //Do work with myStorefrontProvider
-     *
-     * const deregister = async () => {
-     *      await Storefront.deregister("my-storefront-id");
-     * }
-     * ```
-     * @param id the id of the provider.
-     */
-    deregister(id: string): Promise<void>;
-    /**
-     * Shows the Storefront window. Awaits for the latest [[`Storefront.register()`]]
-     * internally, so you don't have to. Throws an error if a [[StorefrontProvider]]
-     * doesn't exist (i.e., because `register()` not called previously).
-     *
-     * ```ts
-     * import { Storefront } from "@openfin/workspace";
-     *
-     * const show = async () => {
-     *      await Storefront.show();
-     *      //Do thing after show
-     * }
-     * ```
-     */
-    show(): Promise<void>;
-    /**
-     * Hides the Storefront window. Awaits for the latest [[`Storefront.register()`]]
-     * internally, so you don't have to. Throws an error if a [[StorefrontProvider]]
-     * doesn't exist (i.e., because `register()` was not called previously).
-     *
-     * ```ts
-     * import { Storefront } from "@openfin/workspace";
-     *
-     * const hide = async () => {
-     *      await Storefront.hidef();
-     *      //Do thing after show
-     * }
-     * ```
-     */
-    hide(): Promise<void>;
-}

package/client-api/src/store.d.ts

@@ -1,25 +1,81 @@
 import type { StorefrontProvider, StoreRegistration } from './shapes/store';
 export * from './shapes/store';
-import { StoreButtonConfig } from './shapes/store';
 /**
- * Registers a Storefront provider
+ * Registers a {@link StorefrontProvider}.
+ *
+ * Throws an error if a provider with the same `id` already exists.
+ *
+ * @param provider the implementation of a Storefront provider.
+ *
+ * @example
+ * ```ts
+ * import { Storefront, StorefrontProvider } from "@openfin/workspace";
+ *
+ * const myStorefrontProvider: StorefrontProvider = {
+ *      id: "my-storefront-id"
+ *      title: "My StorefrontProvider"
+ *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
+ *      getApps: () => {...},
+ *      getNavigation: () => {...},
+ *      getLandingPage: () => {...},
+ *      getFooter: () => {...},
+ *      launchApp: () => {...}
+ * };
+ *
+ * await Storefront.register(myStorefrontProvider);
+ *
+ * ```
  */
 export declare const register: (provider: StorefrontProvider) => Promise<StoreRegistration>;
-export interface UpdateButtonConfigRequest {
-    appId: string;
-    primaryButton: StoreButtonConfig;
-    secondaryButtons: StoreButtonConfig[];
-}
 /**
- * Deregister a Storefront provider
+ * API function to deregister a Storefront provider.
+ *
+ * @param id the id of the provider to deregister.
+ * @returns promise - resolves once the provider is deregistered.
+ *
+ * @example
+ * ```ts
+ * import { Storefront, StorefrontProvider } from "@openfin/workspace";
+ *
+ * const myStorefrontProvider: StorefrontProvider = {
+ *      id: "my-storefront-id"
+ *      title: "My StoreFrontProvider"
+ *      icon: "https://cdn.openfin.co/demos/notifications/generator/images/icon-blue.png",
+ *      getApps: () => {...},
+ *      getNavigation: () => {...},
+ *      getLandingPage: () => {...},
+ *      getFooter: () => {...},
+ *      launchApp: () => {...}
+ * };
+ *
+ * await Storefront.register(myStorefrontProvider);
+ *
+ * await Storefront.deregister("my-storefront-id");
+ *
+ * ```
  */
 export declare const deregister: (providerId: string) => Promise<void>;
 /**
- * API function to hide Storefront
+ * API function to hide the Storefront window.
  * @returns promise - invokes hide action
+ *
+ * @example
+ * ```ts
+ * import { Storefront } from "@openfin/workspace";
+ *
+ * await Storefront.hide();
+ * ```
  */
 export declare const hide: () => Promise<void>;
 /**
- * Shows Storefront window if enabled & registered
+ * API function to show the Storefront window.
+ * @returns promise - invokes show action
+ *
+ * @example
+ * ```ts
+ * import { Storefront } from "@openfin/workspace";
+ *
+ * await Storefront.show();
+ * ```
  */
 export declare const show: () => Promise<void>;

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

@@ -335,16 +335,38 @@ export interface PreDefinedButtonConfig {
     iconProps?: IconProps;
     disabled?: boolean;
 }
-declare type ShowHideTabsConfig = {
+/**
+ * Configuration Object for the show/hide tabs button within the browser toolbar
+ *
+ * @example
+ * ```ts
+ * const showHideTabsConfig: ShowHideTabsConfig = {
+ *     type: BrowserButtonType.ShowHideTabs,
+ *     disabled: false
+ * };
+ * ```
+ */
+export declare type ShowHideTabsConfig = {
     type: BrowserButtonType.ShowHideTabs;
     disabled?: boolean;
 };
-declare type LockUnlockPageConfig = {
+/**
+ * Configuration Object for the page lock/unlock button within the browser toolbar
+ *
+ * @example
+ * ```ts
+ * const lockUnlockPageConfig: LockUnlockPageConfig = {
+ *     type: BrowserButtonType.LockUnlockPage,
+ *     disabled: false
+ * };
+ * ```
+ */
+export declare type LockUnlockPageConfig = {
     type: BrowserButtonType.LockUnlockPage;
     disabled?: boolean;
 };
 /**
- *  Buttons on the left of WindowStateButtonOptions
+ * Buttons on the left of WindowStateButtonOptions
  */
 export declare type ToolbarButton = ShowHideTabsConfig | LockUnlockPageConfig | CustomBrowserButtonConfig | PreDefinedButtonConfig;
 export interface ToolbarOptions {

package/common/src/api/protocol/workspace.d.ts

@@ -54,11 +54,6 @@ export interface ChannelClient extends OpenFin.ChannelClient {
  * @returns the channel client for the centralized workspace protocol.
  */
 export declare const getChannelClient: () => Promise<ChannelClient>;
-/**
- * Returns true if the current application was launched via a library (such as the Client APIs).
- * Otherwise, returns false.
- */
-export declare const isLaunchedViaLib: () => Promise<boolean>;
 /**
  * Launches the Workspace Provider.
  * If the Workspace Provider is already running, does nothing.