plugins-pkg: Add basic types declaration files

We should allow plugin developers to use types related to plugins when
then develop them. The whole external plugin development story is still
being defined though, so for now we just export the types for the plugin
registry, Plugin class, and the router types they depend on.

Hopefully in the short term we will be able to provide a more solid and
defined package for defining plugins.

Author: joaquimrocha

plugins-pkg/package.json

@@ -19,7 +19,8 @@
   },
   "files": [
     "bin",
-    "config"
+    "config",
+    "types"
   ],
   "keywords": [
     "headlamp",

plugins-pkg/types/lib/router.d.ts

@@ -0,0 +1,20 @@
+/// <reference types="react" />
+export interface Route {
+    path: string;
+    exact?: boolean;
+    name?: string;
+    noCluster?: boolean;
+    noAuthRequired?: boolean;
+    sidebar: string | null;
+    component: () => JSX.Element;
+}
+export declare const ROUTES: {
+    [routeName: string]: Route;
+};
+export declare function getRoute(routeName: string): Route;
+export declare function getRoutePath(route: Route): string;
+export interface RouteURLProps {
+    cluster?: string;
+    [prop: string]: any;
+}
+export declare function createRouteURL(routeName: string, params?: RouteURLProps): string;

plugins-pkg/types/plugin/index.d.ts

@@ -0,0 +1,15 @@
+import Registry from './registry';
+export declare abstract class Plugin {
+    abstract initialize(register: Registry): boolean;
+}
+declare global {
+    interface Window {
+        pluginLib: {
+            [libName: string]: any;
+        };
+        plugins: {
+            [pluginId: string]: Plugin;
+        };
+        registerPlugin: (pluginId: string, pluginObj: Plugin) => void;
+    }
+}

plugins-pkg/types/plugin/registry.d.ts

@@ -0,0 +1,10 @@
+/// <reference types="react" />
+import { Route } from '../lib/router';
+export default class Registry {
+    registerSidebarItem(parentName: string, itemName: string, itemLabel: string, url: string, opts?: {
+        useClusterURL: boolean;
+    }): void;
+    registerRoute(routeSpec: Route): void;
+    registerDetailsViewHeaderAction(actionName: string, actionFunc: (...args: any[]) => JSX.Element | null): void;
+    registerAppBarAction(actionName: string, actionFunc: (...args: any[]) => JSX.Element | null): void;
+}