@openfin/workspace-platform 12.6.3 → 12.6.5

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

@@ -3,6 +3,7 @@
  * 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';
 /**
@@ -225,11 +226,6 @@ 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.
  */
@@ -486,3 +482,99 @@ 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,81 +1,25 @@
 import type { StorefrontProvider, StoreRegistration } from './shapes/store';
 export * from './shapes/store';
+import { StoreButtonConfig } from './shapes/store';
 /**
- * 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);
- *
- * ```
+ * Registers a Storefront provider
  */
 export declare const register: (provider: StorefrontProvider) => Promise<StoreRegistration>;
+export interface UpdateButtonConfigRequest {
+    appId: string;
+    primaryButton: StoreButtonConfig;
+    secondaryButtons: StoreButtonConfig[];
+}
 /**
- * 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");
- *
- * ```
+ * Deregister a Storefront provider
  */
 export declare const deregister: (providerId: string) => Promise<void>;
 /**
- * API function to hide the Storefront window.
+ * API function to hide Storefront
  * @returns promise - invokes hide action
- *
- * @example
- * ```ts
- * import { Storefront } from "@openfin/workspace";
- *
- * await Storefront.hide();
- * ```
  */
 export declare const hide: () => Promise<void>;
 /**
- * API function to show the Storefront window.
- * @returns promise - invokes show action
- *
- * @example
- * ```ts
- * import { Storefront } from "@openfin/workspace";
- *
- * await Storefront.show();
- * ```
+ * Shows Storefront window if enabled & registered
  */
 export declare const show: () => Promise<void>;