frontend-app-api: add initial app graph types

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2023-10-15 13:04:16 +02:00
parent 6c6f392c74
commit c617af1d6d
2 changed files with 87 additions and 0 deletions
@@ -0,0 +1,22 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * 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.
+ */
+
+export type {
+  AppNode,
+  AppNodeEdges,
+  AppNodeInstance,
+  AppNodeSpec,
+} from './types';
@@ -0,0 +1,65 @@
+/*
+ * Copyright 2023 The Backstage Authors
+ *
+ * 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 {
+  BackstagePlugin,
+  Extension,
+  ExtensionDataRef,
+} from '@backstage/frontend-plugin-api';
+
+/**
+ * The specification for this node in the app graph.
+ * @public
+ */
+export interface AppNodeSpec {
+  id: string;
+  attachTo: { id: string; input: string };
+  extension: Extension<unknown>;
+  disabled: boolean;
+  config?: unknown;
+  source?: BackstagePlugin;
+}
+
+/**
+ * The connections from this node to other nodes.
+ * @public
+ */
+export interface AppNodeEdges {
+  attachedTo: { node: AppNode; input: string };
+  attachments: Map<string, AppNode[]>;
+}
+
+/**
+ * The instance of this node in the app graph.
+ * @public
+ */
+export interface AppNodeInstance {
+  getDataRefs(): ExtensionDataRef<unknown>[];
+  getData<T>(ref: ExtensionDataRef<T>): T | unknown;
+}
+
+/**
+ *
+ * @public
+ */
+export interface AppNode {
+  /** The specification for how this node should be instantiated */
+  spec: AppNodeSpec;
+  /** The edges from this node to other nodes in the app graph */
+  edges: AppNodeEdges;
+  /** The instance of this node, if it was instantiated */
+  instance?: AppNodeInstance;
+}