[v10.0.x] Canvas: Migrate to schema (#70409)

* Canvas: Migrate to schema (#70205) (cherry picked from commit d7a8892f3a) * Revert to old schema structure for 10.0.x to fix build
2023-06-26 11:29:11 -05:00
parent ab087d2a02
commit db22d545ba
13 changed files with 525 additions and 96 deletions
@@ -0,0 +1,131 @@
+// Code generated - EDITING IS FUTILE. DO NOT EDIT.
+//
+// Generated by:
+//     public/app/plugins/gen.go
+// Using jennies:
+//     TSTypesJenny
+//     LatestMajorsOrXJenny
+//     PluginEachMajorJenny
+//
+// Run 'make gen-cue' from repository root to regenerate.
+
+import * as ui from '@grafana/schema';
+
+export enum HorizontalConstraint {
+  Center = 'center',
+  Left = 'left',
+  LeftRight = 'leftright',
+  Right = 'right',
+  Scale = 'scale',
+}
+
+export enum VerticalConstraint {
+  Bottom = 'bottom',
+  Center = 'center',
+  Scale = 'scale',
+  Top = 'top',
+  TopBottom = 'topbottom',
+}
+
+export interface Constraint {
+  horizontal?: HorizontalConstraint;
+  vertical?: VerticalConstraint;
+}
+
+export interface Placement {
+  bottom?: number;
+  height?: number;
+  left?: number;
+  right?: number;
+  top?: number;
+  width?: number;
+}
+
+export enum BackgroundImageSize {
+  Contain = 'contain',
+  Cover = 'cover',
+  Fill = 'fill',
+  Original = 'original',
+  Tile = 'tile',
+}
+
+export interface BackgroundConfig {
+  color?: ui.ColorDimensionConfig;
+  image?: ui.ResourceDimensionConfig;
+  size?: BackgroundImageSize;
+}
+
+export interface LineConfig {
+  color?: ui.ColorDimensionConfig;
+  width?: number;
+}
+
+export interface ConnectionCoordinates {
+  x: number;
+  y: number;
+}
+
+export enum ConnectionPath {
+  Straight = 'straight',
+}
+
+export interface CanvasConnection {
+  color?: ui.ColorDimensionConfig;
+  path: ConnectionPath;
+  size?: ui.ScaleDimensionConfig;
+  source: ConnectionCoordinates;
+  target: ConnectionCoordinates;
+  targetName?: string;
+}
+
+export interface CanvasElementOptions {
+  background?: BackgroundConfig;
+  border?: LineConfig;
+  /**
+   * TODO: figure out how to define this (element config(s))
+   */
+  config?: unknown;
+  connections?: Array<CanvasConnection>;
+  constraint?: Constraint;
+  name: string;
+  placement?: Placement;
+  type: string;
+}
+
+export const defaultCanvasElementOptions: Partial<CanvasElementOptions> = {
+  connections: [],
+};
+
+export interface Options {
+  /**
+   * Enable inline editing
+   */
+  inlineEditing: boolean;
+  /**
+   * The root element of canvas (frame), where all canvas elements are nested
+   * TODO: Figure out how to define a default value for this
+   */
+  root: {
+    /**
+     * Name of the root element
+     */
+    name: string;
+    /**
+     * Type of root element (frame)
+     */
+    type: 'frame';
+    /**
+     * The list of canvas elements attached to the root element
+     */
+    elements: Array<CanvasElementOptions>;
+  };
+  /**
+   * Show all available element types
+   */
+  showAdvancedTypes: boolean;
+}
+
+export const defaultOptions: Partial<Options> = {
+  inlineEditing: true,
+  showAdvancedTypes: true,
+};