@openfin/workspace-platform 6.3.4 → 7.0.0

package/client-api-platform/src/api/browser/browser-module.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="openfin-adapter/fin" />
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../../../common/src/api/pages/shapes';
 import { OpenPageTabContextMenuRequest } from '../../../../client-api-platform/src/index';
-import { OpenGlobalContextMenuRequest, OpenViewTabContextMenuRequest, ToolbarOptions, WindowStateButtonOptions } from '../../../../client-api-platform/src/shapes';
+import { OpenGlobalContextMenuRequest, OpenSaveMenuRequest, OpenViewTabContextMenuRequest, ToolbarOptions, WindowStateButtonOptions } from '../../../../client-api-platform/src/shapes';
 export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     identity: OpenFin.Identity;
     openfinWindow: import("openfin-adapter").Window;
@@ -17,4 +17,5 @@ export declare const getBrowserModule: (identity: OpenFin.Identity) => {
     replaceWindowStateButtonOptions: (options: WindowStateButtonOptions) => Promise<void>;
     _openViewTabContextMenu: (req: OpenViewTabContextMenuRequest) => Promise<any>;
     _openPageTabContextMenu: (req: OpenPageTabContextMenuRequest) => Promise<any>;
+    _openSaveModal: (req: OpenSaveMenuRequest) => Promise<any>;
 };

package/client-api-platform/src/api/browser/index.d.ts

@@ -17,6 +17,7 @@ export declare const getBrowserApi: (identity: OpenFin.ApplicationIdentity) => {
         replaceWindowStateButtonOptions: (options: import("../../shapes").WindowStateButtonOptions) => Promise<void>;
         _openViewTabContextMenu: (req: import("../../shapes").OpenViewTabContextMenuRequest) => Promise<any>;
         _openPageTabContextMenu: (req: import("../../shapes").OpenPageTabContextMenuRequest) => Promise<any>;
+        _openSaveModal: (req: import("../../shapes").OpenSaveMenuRequest) => Promise<any>;
     };
     createWindow: (options: BrowserCreateWindowRequest) => Promise<BrowserWindowModule>;
     getAllAttachedPages: () => Promise<AttachedPage[]>;

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

@@ -36,7 +36,16 @@ export declare enum ChannelAction {
     OpenGlobalContextMenuInternal = "openGlobalContextMenuInternal",
     OpenViewTabContextMenuInternal = "openViewTabContextMenuInternal",
     OpenPageTabContextMenuInternal = "openPageTabContextMenuInternal",
-    InvokeCustomActionInternal = "invokeCustomActionInternal"
+    InvokeCustomActionInternal = "invokeCustomActionInternal",
+    GetSavedWorkspace = "getSavedWorkspace",
+    CreateSavedWorkspace = "createSavedWorkspace",
+    UpdateSavedWorkspace = "updateSavedWorkspace",
+    DeleteSavedWorkspace = "deleteSavedWorkspace",
+    GetSavedWorkspaces = "getSavedWorkspaces",
+    SaveWorkspace = "saveWorkspace",
+    GetCurrentWorkspace = "getCurrentWorkspace",
+    SetCurrentWorkspace = "setCurrentWorkspace",
+    GetActiveWorkspace = "getActiveWorkspace"
 }
 /**
  * Get a channel client for a specific Workspace platform.

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

@@ -1,5 +1,5 @@
 import { Page } from '../../../common/src/api/pages/shapes';
-import type { CreateSavedPageRequest, UpdateSavedPageRequest } from '../shapes';
+import type { CreateSavedPageRequest, CreateSavedWorkspaceRequest, UpdateSavedPageRequest, UpdateSavedWorkspaceRequest, Workspace } from '../shapes';
 export declare const getStorageApi: (identity: any) => {
     createPage: (req: CreateSavedPageRequest) => Promise<any>;
     deletePage: (id: string) => Promise<any>;
@@ -7,4 +7,10 @@ export declare const getStorageApi: (identity: any) => {
     getPage: (id: string) => Promise<any>;
     getPages: (query?: string) => Promise<Page[]>;
     savePage: (page: Page) => Promise<any>;
+    createWorkspace: (req: CreateSavedWorkspaceRequest) => Promise<any>;
+    deleteWorkspace: (id: string) => Promise<any>;
+    updateWorkspace: (req: UpdateSavedWorkspaceRequest) => Promise<any>;
+    getWorkspace: (id: string) => Promise<any>;
+    getWorkspaces: (query?: string) => Promise<Workspace[]>;
+    saveWorkspace: (workspace: Workspace) => Promise<any>;
 };

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

@@ -0,0 +1 @@
+export declare const handleNameCollision: (initialName: string, existingNames: string[]) => string;

package/client-api-platform/src/api/workspaces/idb.d.ts

@@ -0,0 +1,12 @@
+import { Workspace } from '../../../../client-api/src/shapes';
+export declare const store: import("idb-keyval").UseStore;
+export declare function getWorkspace(id: string): Promise<Workspace>;
+export declare function getWorkspaceList(filter?: string): Promise<Workspace[]>;
+export declare function createWorkspace({ workspace }: {
+    workspace: any;
+}): Promise<void>;
+export declare function deleteWorkspace(id: string): Promise<void>;
+export declare function updateWorkspace({ workspaceId, workspace }: {
+    workspaceId: any;
+    workspace: any;
+}): Promise<void>;

package/client-api-platform/src/api/workspaces/index.d.ts

@@ -0,0 +1,28 @@
+import type { CreateSavedWorkspaceRequest, Workspace } from '../../../../client-api-platform/src/shapes';
+/**
+ * Set the current active workspace.
+ */
+export declare function setCurrentWorkspace(workspace: Workspace): Promise<void>;
+/**
+ * Get a workspace data structure that represents the users current desktop.
+ * @returns the current active workspace.
+ */
+export declare function getCurrentWorkspace(): Promise<any>;
+/**
+ * Get the active workspace.
+ * @returns the current active workspace.
+ */
+export declare function getActiveWorkspace(): Workspace | undefined;
+export declare const createWorkspaceInStorage: (req: CreateSavedWorkspaceRequest) => Promise<any>;
+export declare const getWorkspacesInStorage: () => Promise<Workspace[]>;
+export declare const getWorkspaceInStorage: (id: string) => Promise<Workspace>;
+export declare const deleteWorkspaceInStorage: (id: string) => Promise<any>;
+export declare const updateWorkspaceInStorage: (req: any) => Promise<any>;
+export declare const saveWorkspace: (workspace: Workspace) => Promise<any>;
+/**
+ * Checks if a given workspace name is unique
+ * If not, add a progressive number to it
+ * @param initialName The initial name to test
+ * @returns string: a unique workspace name
+ */
+export declare function getUniqueWorkspaceTitle(initialName?: string): Promise<string>;

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

@@ -5,10 +5,10 @@ import { IconProps } from '@openfin/ui-library';
 import type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
 import type { CustomThemes } from '../../common/src/api/theming';
 import type { App } from '../../client-api/src/shapes';
-export type { CustomThemes } from '../../common/src/api/theming';
-export type { App, Image, AppIntent } from '../../client-api/src/shapes';
 export { AppManifestType } from '../../client-api/src/shapes';
-export type { AttachedPage, Page, PageWithUpdatableRuntimeAttribs, PageLayout, PageLayoutDetails } from '../../common/src/api/pages/shapes';
+export type { App, AppIntent, Image } from '../../client-api/src/shapes';
+export type { AttachedPage, Page, PageLayout, PageLayoutDetails, PageWithUpdatableRuntimeAttribs } from '../../common/src/api/pages/shapes';
+export type { CustomThemes } from '../../common/src/api/theming';
 /**
  * Request for creating a saved page in persistent storage.
  */
@@ -53,7 +53,10 @@ export interface ContextMenuItemData {
 export declare enum GlobalContextMenuOptionType {
     NewWindow = "NewWindow",
     NewPage = "NewPage",
+    SavePage = "SavePage",
+    SavePageAs = "SavePageAs",
     CloseWindow = "CloseWindow",
+    DeleteWorkspace = "DeleteWorkspace",
     OpenStorefront = "OpenStorefront",
     Quit = "Quit",
     Custom = "Custom"
@@ -65,12 +68,16 @@ export declare enum PageTabContextMenuOptionType {
     Duplicate = "Duplicate",
     Rename = "Rename",
     Save = "Save",
+    SaveAs = "Save As",
     Custom = "Custom"
 }
 /**Shape of the data property of a global context menu template item */
 export interface GlobalContextMenuItemData extends ContextMenuItemData {
     type: GlobalContextMenuOptionType;
 }
+export interface WorkspaceContextMenuItemData extends GlobalContextMenuItemData {
+    workspaceId: string;
+}
 /**Configuration of an option in the global context menu */
 export interface GlobalContextMenuItemTemplate extends OpenFin.MenuItemTemplate {
     data: GlobalContextMenuItemData;
@@ -836,6 +843,62 @@ export interface WorkspacePlatformStorage {
      * @param page the page to save.
      */
     savePage(page: Page): Promise<void>;
+    /**
+     * Get all workspaces that are saved in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const workspaces = await workspacePlatform.Storage.getWorkspaces();
+     * ```
+     */
+    getWorkspaces(): Promise<Workspace[]>;
+    /**
+     * Get a specific workspace in persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * const myWorkspace = await workspacePlatform.Storage.getWorkspace('myWorkspaceId');
+     * ```
+     * @param id the id of the workspace to get.
+     */
+    getWorkspace(id: string): Promise<Workspace>;
+    /**
+     * Create a workspace in persistent storage.
+     *
+     * @param workspace the workspace to create in persistent storage.
+     */
+    createWorkspace(workspace: CreateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Update a workspace in persistent storage.
+     * @param req the update saved workspace request.
+     */
+    updateWorkspace(req: UpdateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Delete a workspace from persistent storage.
+     *
+     * ```ts
+     * import * as WorkspacePlatform from '@openfin/workspace-platform';
+     *
+     * const workspacePlatform = WorkspacePlatform.getCurrentSync();
+     * await workspacePlatform.Storage.deleteWorkspace('myWorkspaceId');
+     * ```
+     * @param id the id of the workspace to delete.
+     */
+    deleteWorkspace(id: string): Promise<void>;
+    /**
+     * Save a workspace in persistent storage.
+     *
+     * This is a helper function that will call `getWorkspace` to determine if a workspace is already in storage.
+     * If the workspace is already in storage, it will call `updateWorkspace`.
+     * If it does not exist in storage, the function will call `createWorkspace` instead.
+     *
+     * @param workspace the workspace to save.
+     */
+    saveWorkspace(workspace: Workspace): Promise<void>;
 }
 /**
  * Request for launching an application.
@@ -891,6 +954,20 @@ export interface WorkspacePlatformModule extends OpenFin.Platform {
      * @param req the launch app request.
      */
     launchApp(req: LaunchAppRequest): Promise<void>;
+    /**
+     * Gets a workspace data structure that represents the current state of the user's desktop.
+     */
+    getCurrentWorkspace(): Promise<Workspace>;
+    /**
+     * Closes content from the current workspace and applies the given workspace to the user's desktop.
+     * The given workspace becomes the active workspace, and the content of the workspace is launched.
+     * @param workspace the workspace to set as current active workspace.
+     */
+    setCurrentWorkspace(workspace: Workspace): Promise<void>;
+    /**
+     * Gets a workspace data structure that represents the active state of the user's desktop.
+     */
+    getActiveWorkspace(): Promise<Workspace>;
     /**
      * The browser window factory for the Workspace Platform.
      */
@@ -930,6 +1007,31 @@ export interface WorkspacePlatformProvider extends OpenFin.PlatformProvider {
      * @param id of the id of the page to delete.
      */
     deleteSavedPage(id: string): Promise<void>;
+    /**
+     * Implementation for getting a list of saved workspaces from persistent storage.
+     * @param query an optional query.
+     */
+    getSavedWorkspaces(query?: string): Promise<Workspace[]>;
+    /**
+     * Implementation for getting a single workspace in persistent storage.
+     * @param id
+     */
+    getSavedWorkspace(id: string): Promise<Workspace>;
+    /**
+     * Implementation for creating a saved workspace in persistent storage.
+     * @param req the create saved workspace request.
+     */
+    createSavedWorkspace(req: CreateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Implementation for updating a saved workspace in persistent storage.
+     * @param req the update saved workspace request.
+     */
+    updateSavedWorkspace(req: UpdateSavedWorkspaceRequest): Promise<void>;
+    /**
+     * Implementation for deleting a saved workspace in persistent storage.
+     * @param id of the id of the workspace to delete.
+     */
+    deleteSavedWorkspace(id: string): Promise<void>;
     /**
      * Implementation for showing a global context menu given a menu template,
      * handler callback, and screen coordinates. For an example of overriding, see {@link BrowserOverrideCallback}.
@@ -1141,3 +1243,40 @@ export interface BrowserInitConfig {
      */
     interopOverride?: OpenFin.OverrideCallback<InteropBroker, InteropBroker>;
 }
+interface WorkspaceMetadata {
+    APIVersion: string;
+    timestamp: string;
+}
+export interface Workspace {
+    workspaceId: string;
+    title: string;
+    metadata: WorkspaceMetadata;
+    attributes: string[];
+    snapshot: OpenFin.Snapshot;
+}
+/**
+ * Request for creating a saved workspace in persistent storage.
+ */
+export interface CreateSavedWorkspaceRequest {
+    /** The workspace to create. */
+    workspace: Workspace;
+}
+/**
+ * Request for updating a saved workspace in persistent storage.
+ */
+export interface UpdateSavedWorkspaceRequest {
+    /** The ID of the workspace to update. */
+    workspaceId: string;
+    /** The updated workspace. */
+    workspace: Workspace;
+}
+/**
+ * Request to create a save modal.
+ * @private
+ */
+export interface OpenSaveMenuRequest {
+    menuType: SaveModalType;
+    id: string;
+    x?: number;
+    y?: number;
+}

package/common/src/api/browser-protocol.d.ts

@@ -12,12 +12,17 @@ export interface AddToChannelRequest {
     newChannelId: string;
     selectedViews: OpenFin.Identity[];
 }
+/**
+ * These actions are used to handle functionality activated by user in the UI (e.g. context menu)
+ * and hence show dialogs, indicators etc.
+ * Not to be confused with attached pages actions, which are for API use.
+ */
 export declare enum ChannelAction {
     CloseBrowserWindow = "close-browser-window",
     QuitPlatform = "quit-platform",
     ClosePage = "close-page",
     AddToChannel = "add-to-channel",
     RemoveFromChannel = "remove-from-channel",
-    SavePage = "save-page",
+    OpenSaveModalInternal = "open-save-modal-internal",
     DuplicatePage = "duplicate-page"
 }

package/common/src/components/Indicator/Indicator.constants.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Here we define an Indicator only explicitly by needing an ID for reference over the wire.
+ * Type and message are meant to provide actual context and meaning to an indicator, but
+ * they are not required in the case of destroying an existing indicator.
+ */
+export interface Indicator {
+    id: string;
+    type?: IndicatorType;
+    message?: string;
+}
+/**
+ * Indicator types are meant to provide additional context to the indicator.
+ */
+export declare enum IndicatorType {
+    ERROR = "error",
+    SUCCESS = "success",
+    INFO = "info"
+}

package/common/src/utils/a11y/search.a11y.d.ts

@@ -0,0 +1,31 @@
+export declare type Role = string;
+export declare type AriaOwns = undefined | string;
+export declare type AriaHaspopup = boolean | 'false' | 'true' | 'menu' | 'listbox' | 'tree' | 'grid' | 'dialog';
+export declare type AriaAutocomplete = 'none' | 'inline' | 'list' | 'both';
+export declare type AriaControls = undefined | string;
+export declare type AriaActivedescendant = undefined | string;
+export declare type AriaExpanded = boolean | 'false' | 'true';
+export declare type AriaLive = 'none' | 'polite' | 'assertive';
+export declare type A11yBox = {
+    'role': Role;
+    'aria-expanded': AriaExpanded;
+    'aria-owns': AriaOwns;
+    'aria-haspopup': AriaHaspopup;
+};
+export declare type A11yInput = {
+    'aria-controls': AriaControls;
+    'aria-autocomplete': AriaAutocomplete;
+    'aria-activedescendant': AriaActivedescendant;
+};
+export interface AriaSearchInput {
+    role: Role;
+    controls: AriaControls;
+    autocomplete: AriaAutocomplete;
+    owns: AriaOwns;
+    haspopup: AriaHaspopup;
+    searchLabelID: string;
+    searchResultID: string;
+    searchInputID: string;
+    labelText: string;
+}
+export declare const A11ySearch: AriaSearchInput;

package/common/src/utils/a11y/speak.d.ts

@@ -0,0 +1,6 @@
+import { AriaLive } from './search.a11y';
+/**
+ * Makes the screen reader speak the provided message.
+ * https://a11y-guidelines.orange.com/en/web/components-examples/make-a-screen-reader-talk/
+ */
+export declare const speak: (msg: string, priority?: AriaLive) => void;

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

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

package/common/src/utils/global-context-menu.d.ts

@@ -1,3 +1,15 @@
 import { NamedIdentity } from 'openfin-adapter/src/identity';
+import { MenuItemType } from '../../../common/src/utils/context-menu';
+import * as WP from '../../../client-api-platform/src/index';
 import { GlobalContextMenuItemTemplate } from '../../../client-api-platform/src/shapes';
+export declare const getAllSavedWorkspaces: () => Promise<{
+    label: string;
+    type: MenuItemType;
+    enabled: boolean;
+    checked: boolean;
+    data: {
+        type: WP.GlobalContextMenuOptionType;
+        workspaceId: string;
+    };
+}[]>;
 export declare const getGlobalContextMenuTemplate: (winIdentity: NamedIdentity) => Promise<GlobalContextMenuItemTemplate[]>;

package/common/src/utils/indicators/browser.d.ts

@@ -0,0 +1,16 @@
+export declare enum BrowserIndicatorIcon {
+    Locked = "LockClosedIcon",
+    Unlocked = "LockOpen1Icon"
+}
+/**
+ * Creates a window containing an error indicator
+ */
+export declare function showBrowserError(message: string, parentBrowserName: string, icon?: BrowserIndicatorIcon): Promise<void>;
+/**
+ * Creates a window containing a success indicator
+ */
+export declare function showBrowserSuccess(message: string, parentBrowserName: string, icon?: BrowserIndicatorIcon): Promise<void>;
+/**
+ * Creates a window containing an info indicator
+ */
+export declare function showBrowserInfo(message: string, parentBrowserName: string, icon?: BrowserIndicatorIcon): Promise<void>;

package/common/src/utils/indicators/helper.d.ts

@@ -0,0 +1,2 @@
+/// <reference types="openfin-adapter/fin" />
+export default function makeShowIndicator(opts?: OpenFin.PlatformWindowCreationOptions): (namespace: string, url: string, message: string, type: string) => Promise<void>;

package/common/src/utils/local-storage-key.d.ts

@@ -1,5 +1,5 @@
 declare enum LocalStorageKey {
-    LastLaunchedWorkspaceId = "activeWorkspaceId",
+    CurrentWorkspaceId = "currentWorkspaceId",
     LastFocusedBrowserWindow = "lastFocusedBrowserWindow",
     MachineName = "machineName",
     NewTabPageLayout = "NewTabPageLayout",

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

@@ -14,7 +14,7 @@ export declare enum PageRoute {
     BrowserPopupMenu = "/browser/popup-menu/",
     Provider = "/provider/",
     BrowserPopupMenuSharePage = "/browser/popup-menu/share-page/",
-    BrowserPopupMenuSavePage = "/browser/popup-menu/save-page/",
+    BrowserPopupMenuSaveModal = "/browser/popup-menu/save-modal/",
     BrowserPopupMenuLayouts = "/browser/popup-menu/layouts/layouts/",
     BrowserPopupMenuColorLinking = "/browser/popup-menu/color-linking/color-linking/",
     BrowserIndicator = "/browser/indicator/",
@@ -41,7 +41,7 @@ declare const _default: {
     BrowserPopupMenu: PageRoute.BrowserPopupMenu;
     Provider: PageRoute.Provider;
     BrowserPopupMenuSharePage: PageRoute.BrowserPopupMenuSharePage;
-    BrowserPopupMenuSavePage: PageRoute.BrowserPopupMenuSavePage;
+    BrowserPopupMenuSaveModal: PageRoute.BrowserPopupMenuSaveModal;
     BrowserPopupMenuLayouts: PageRoute.BrowserPopupMenuLayouts;
     BrowserPopupMenuColorLinking: PageRoute.BrowserPopupMenuColorLinking;
     BrowserIndicator: PageRoute.BrowserIndicator;

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

@@ -0,0 +1,61 @@
+import type { AssetRoute, 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.
+ * More information can be found here:
+ * https://nextjs.org/docs/advanced-features/multi-zones
+ */
+export declare enum Zone {
+    Home = "/home",
+    Browser = "/browser",
+    Provider = "/provider",
+    Storefront = "/storefront"
+}
+export declare function getRouterZone(): "" | Zone;
+/**
+ * Gets the router's base path with the zone stripped out.
+ */
+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;
+/**
+ * Gets the route without the zone prefix.
+ * @param route the route to remove the zone prefix from.
+ * @returns the route without the zone.
+ */
+export declare function getRouteWithoutZone(route: PageRoute | string): string;
+/**
+ * Get the absolute path to the route.
+ */
+export declare function getAbsoluteRoutePath(route: PageRoute | string): string;
+/**
+ * Get the base path of the router.
+ * The base path of the router contains the router's zone as a postfix.
+ */
+export declare function getBasePath(): string;
+export declare function resolveAbsolutePath(path: string): string;
+/**
+ * Gets the path to the route with the router's base path.
+ * @param route the route.
+ * @returns the route with the router's base path.
+ */
+export declare function getRoutePath(route: PageRoute): string;
+/**
+ * Concatenates a specified origin URL with a specified path.
+ * @returns the origin concatenated with the specified path.
+ */
+export declare function getOriginWithPath(origin: string, path: string): string;
+/**
+ * Read query parameters of current window location.
+ * @returns the query parameters.
+ */
+export declare function getQuery(): URLSearchParams;
+export declare function getPathnameWithBasePath(pathname: string): string;
+/**
+ * Get the current route.
+ * @returns
+ */
+export declare function getCurrentRoute(): PageRoute;

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

@@ -0,0 +1,2 @@
+export * from './base';
+export * from './next';

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

@@ -0,0 +1,43 @@
+import { NextRouter, withRouter as nextWithRouter } from 'next/router';
+import { PageRoute } from '../route';
+/**
+ * All router events.
+ */
+export declare enum RouterEvent {
+    RouteChangeComplete = "routeChangeComplete"
+}
+/**
+ * React hook for components that want to use router.
+ * Underlying component will be rerendered when the routing of the current page changes.
+ */
+export declare const withRouter: typeof nextWithRouter;
+/**
+ * The type of router.
+ */
+export declare type Router = NextRouter;
+/**
+ * Prefetch a route.
+ * @param route the route to prefetch.
+ */
+export declare function prefetch(route: PageRoute): Promise<void>;
+/**
+ * Navigate to another route.
+ * @param route the route to navigate to.
+ */
+export declare function navigate(route: PageRoute | string): Promise<boolean>;
+/**
+ * Listen for a router event.
+ * @param event the event to listen for.
+ * @param listener the listener to call when the event occurs.
+ */
+export declare function addRouterListener(event: RouterEvent, listener: (...args: any[]) => any): Promise<void>;
+/**
+ * Stop listening for a router event.
+ * @param event the event to stop listening for.
+ * @param listener the listener to remove.
+ */
+export declare function removeRouterListener(event: RouterEvent, listener: (...args: any[]) => any): Promise<void>;
+/**
+ * Navigate the back a route.
+ */
+export declare function navigateBack(): Promise<void>;

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

@@ -0,0 +1,11 @@
+export interface RegisterUsageStatus {
+    apiVersion?: string;
+    allowed: boolean;
+    rejectionCode?: string;
+}
+export declare const registerBrowserUsage: (status: RegisterUsageStatus) => Promise<void>;
+export declare const registerHomeUsage: (status: RegisterUsageStatus) => Promise<void>;
+export declare const registerStorefrontUsage: (status: RegisterUsageStatus) => Promise<void>;
+export declare const registerNotificationUsage: (status: RegisterUsageStatus) => Promise<void>;
+export declare const registerPlatformUsage: (status: RegisterUsageStatus) => Promise<void>;
+export declare const registerThemingUsage: (status: RegisterUsageStatus) => Promise<void>;