1 files changed, 89 insertions, 0 deletions
diff --git a/ui/src/public/index.ts b/ui/src/public/index.ts
new file mode 100644
index 000000000..fc1040571
--- /dev/null
+++ b/ui/src/public/index.ts
@@ -0,0 +1,89 @@
+// Copyright (C) 2022 The Android Open Source Project
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+import {EngineProxy} from '../common/engine';
+import {TracePluginFactory} from '../common/plugins';
+import {TrackControllerFactory} from '../controller/track_controller';
+import {TrackCreator} from '../frontend/track';
+
+export {EngineProxy} from '../common/engine';
+export {
+  LONG,
+  LONG_NULL,
+  NUM,
+  NUM_NULL,
+  STR,
+  STR_NULL,
+} from '../common/query_result';
+
+export interface TrackInfo {
+  // The id of this 'type' of track. This id is used to select the
+  // correct |TrackCreator| to construct the track.
+  trackKind: string;
+
+  // A human readable name for this specific track. It will normally be
+  // displayed on the left-hand-side of the track.
+  name: string;
+
+  // An opaque config for the track.
+  config: {};
+}
+
+// Called any time a trace is loaded. Plugins should return all
+// potential tracks. Zero or more of the provided tracks may be
+// instantiated depending on the users choices.
+export type TrackProvider = (engine: EngineProxy) => Promise<TrackInfo[]>;
+
+// The public API plugins use to extend the UI. This is passed to each
+// plugin via the exposed 'activate' function.
+export interface PluginContext {
+  // DEPRECATED. In prior versions of the UI tracks were split into a
+  // 'TrackController' and a 'Track'. In more recent versions of the UI
+  // the functionality of |TrackController| has been merged into Track so
+  // |TrackController|s are not necessary in new code.
+  registerTrackController(track: TrackControllerFactory): void;
+
+  // Register a |TrackProvider|. |TrackProvider|s return |TrackInfo| for
+  // all potential tracks in a trace. The core UI selects some of these
+  // |TrackInfo|s and constructs concrete Track instances using the
+  // registered |TrackCreator|s.
+  registerTrackProvider(provider: TrackProvider): void;
+
+  // Register a track factory. The core UI invokes |TrackCreator| to
+  // construct tracks discovered by invoking |TrackProvider|s.
+  // The split between 'construction' and 'discovery' allows
+  // plugins to reuse common tracks for new data. For example: the
+  // dev.perfetto.AndroidGpu plugin could register a TrackProvider
+  // which returns GPU counter tracks. The counter track factory itself
+  // could be registered in dev.perfetto.CounterTrack - a whole
+  // different plugin.
+  registerTrack(track: TrackCreator): void;
+
+  // Register a new plugin factory for a plugin whose lifecycle in linked to
+  // that of the trace.
+  registerTracePluginFactory<T>(pluginFactory: TracePluginFactory<T>): void;
+}
+
+export interface PluginInfo {
+  // A unique string for your plugin. To ensure the name is unique you
+  // may wish to use a URL with reversed components in the manner of
+  // Java package names.
+  pluginId: string;
+
+  // This function is called when the plugin is loaded. Generally this
+  // is called at most once shortly after the UI is loaded. However in
+  // some situations it can be called multiple times - for example
+  // when the user is toggling plugins on/off.
+  activate: (ctx: PluginContext) => void;
+}