@openfin/workspace 3.0.0 → 4.0.0

package/shapes.d.ts

@@ -1,273 +0,0 @@
-/**
- * API reference for the Workspace Client APIs.
- */
-/**
- * Describes the type of the app directory entry `manifest` attributes.
- * Launch mechanics are determined by the manifest type.
- */
-export declare enum AppManifestType {
-    /**
-     * A snapshot manifest.
-     */
-    Snapshot = "snapshot",
-    /**
-     * A classic OpenFin app manifest.
-     */
-    Manifest = "manifest",
-    /**
-     * A view manifest.
-     */
-    View = "view",
-    /**
-     * A manifest for an external application.
-     */
-    External = "external"
-}
-export interface AppIntent {
-    name: string;
-    displayName: string;
-    contexts: string[];
-}
-/**
- * Detailed metadata describing an image.
- */
-export interface Image {
-    src: string;
-    type?: string;
-    size?: string;
-    purpose?: string;
-}
-/**
- * Detailed metadata describing an application.
- */
-export interface App {
-    /**
-     * Unique identifier for an application.
-     */
-    appId: string;
-    /**
-     * A UI friendly title for the application.
-     */
-    title: string;
-    /**
-     * URL to application manifest.
-     */
-    manifest: string;
-    /**
-     * UI friendly description for an application.
-     */
-    description?: string;
-    /**
-     * Describes the type of manifest resolved by the `manifest` field.
-     * Launch mechanics are determined by the manifest type.
-     */
-    manifestType: AppManifestType | string;
-    /**
-     * A list of icons that can be rendered in UI for this application.
-     */
-    icons: Image[];
-    /**
-     * A list of optional images that highlight application functionality.
-     */
-    images?: Image[];
-    intents?: AppIntent[];
-    tags?: string[];
-    version?: string;
-    publisher: string;
-    contactEmail?: string;
-    supportEmail?: string;
-}
-export declare enum StorefrontTemplate {
-    LandingPage = "landingPage",
-    AppGrid = "appGrid"
-}
-/**
- * Represents a link to be rendered inside Storefront.
- */
-export interface StorefrontLink {
-    /**
-     * A UI friendly title to render the link as.
-     */
-    title: string;
-    /**
-     * When the rendered `title` text is clicked, the user will be navigated to this URL.
-     */
-    url: string;
-}
-export interface StorefrontFooter {
-    /**
-     * A logo to be displayed on the Storefront's footer.
-     */
-    logo: Image;
-    /**
-     * A set of links to display on Storefront's footer.
-     */
-    links: [StorefrontLink?, StorefrontLink?, StorefrontLink?];
-    text: string;
-}
-/**
- * Render a navigation section on the left panel of Storefront.
- */
-export interface StorefrontNavigationSection {
-    /**
-     * Unique identifier for the navigation section.
-     */
-    id: string;
-    /**
-     * The UI friendly title of the navigation section.
-     */
-    title: string;
-    /**
-     * Navigation items to render under this section.
-     * 1-5 Navigation Items are supported.
-     */
-    items: [
-        StorefrontNavigationItem,
-        StorefrontNavigationItem?,
-        StorefrontNavigationItem?,
-        StorefrontNavigationItem?,
-        StorefrontNavigationItem?
-    ];
-}
-export interface StorefrontLandingPage {
-    hero?: {
-        title: string;
-        description: string;
-        cta: StorefrontNavigationItem;
-        image: Image;
-    };
-    topRow: {
-        title: string;
-        items: [
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?
-        ];
-    };
-    middleRow: {
-        title: string;
-        apps: [App?, App?, App?, App?, App?, App?];
-    };
-    bottomRow: {
-        title: string;
-        items: [
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?,
-            StorefrontDetailedNavigationItem?
-        ];
-    };
-}
-/**
- * Render a grid of applications in Storefront.
- */
-export interface StorefrontAppGrid {
-    /**
-     * The apps to render in the grid.
-     */
-    apps: App[];
-}
-export interface StorefrontNavigationItemBase {
-    /**
-     * An ID for referencing the navigation item. Must be unique.
-     */
-    id: string;
-    /**
-     * UI friendly name for the navigation item.
-     */
-    title: string;
-}
-export interface StorefrontNavigationItemDetails {
-    description: string;
-    image: Image;
-}
-/**
- * Template for rendering a navigation item that renders a app grid when clicked.
- */
-export interface StorefrontNavigationItemAppGrid extends StorefrontNavigationItemBase {
-    templateId: StorefrontTemplate.AppGrid;
-    /**
-     * Render an app grid when navigation item is pressed.
-     */
-    templateData: StorefrontAppGrid;
-}
-/**
- * Template for rendering a navigation item that renders another landing page when clicked.
- */
-export interface StorefrontNavigationItemLandingPage extends StorefrontNavigationItemBase {
-    templateId: StorefrontTemplate.LandingPage;
-    /**
-     * Render a landing page when navigation item is pressed.
-     */
-    templateData: StorefrontLandingPage;
-}
-/**
- * Render an item in the navigation bar of Storefront.
- */
-export declare type StorefrontNavigationItem = StorefrontNavigationItemAppGrid | StorefrontNavigationItemLandingPage;
-/**
- *  Render an item in the navigation bar of Storefront with a description and image.
- */
-export declare type StorefrontDetailedNavigationItem = StorefrontNavigationItem & StorefrontNavigationItemDetails;
-export interface StorefrontProviderInfo {
-    /**
-     * Unique identifier for the Storefront provider.
-     */
-    id: string;
-    /**
-     * A UI friendly title for the platform Storefront.
-     * This will be used in the Storefront selection dropdown.
-     */
-    title: string;
-}
-/**
- * Describes a Storefront provided by a platform.
- * A platform must provide an object that satisfies this interface in order to register with the Storefront.
- */
-export interface StorefrontProvider extends StorefrontProviderInfo {
-    /**
-     * Get a list of apps to populate the platform's Storefront with.
-     */
-    getApps(): Promise<App[]>;
-    /**
-     * Get the main landing page for the platform's Storefront.
-     */
-    getLandingPage(): Promise<StorefrontLandingPage>;
-    /**
-     * Get the Storefront navigation sections for the left nav bar.
-     */
-    getNavigation(): Promise<[StorefrontNavigationSection?, StorefrontNavigationSection?]>;
-    /**
-     * Get the footer for the platform's Storefront.
-     */
-    getFooter(): Promise<StorefrontFooter>;
-    /**
-     * Launch an app provided by the platform's Storefront.
-     */
-    launchApp(app: App): Promise<void>;
-}
-/**
- * Interface that contains functions for integrating with Storefront.
- */
-export interface StorefrontAPI {
-    /**
-     * Register a Storefront provider.
-     * @param provider the implementation of a Storefront provider.
-
-     */
-    register(provider: StorefrontProvider): Promise<void>;
-    /**
-     * Show the Storefront UI.
-     */
-    show(): Promise<void>;
-    /**
-     * Hide the Storefront UI.
-     */
-    hide(): Promise<void>;
-}
-export declare const Storefront: StorefrontAPI;
-/**
- * Default Workspace implementation for launching an application.
- * @param app the application to launch.
- */
-export declare const launchApp: (app: App) => Promise<void>;