Add interfaces for layering data on Visualizations

src/plugins/expressions/common/expression_types/specs/index.ts

@@ -44,6 +44,7 @@ import { render } from './render';
 import { shape } from './shape';
 import { string } from './string';
 import { style } from './style';
+import { visLayers } from './vis_layers';
 import { AnyExpressionTypeDefinition } from '../types';
 
 export const typeSpecs: AnyExpressionTypeDefinition[] = [
@@ -63,6 +64,7 @@ export const typeSpecs: AnyExpressionTypeDefinition[] = [
   shape,
   string,
   style,
+  visLayers,
 ];
 
 export * from './boolean';
@@ -81,3 +83,4 @@ export * from './render';
 export * from './shape';
 export * from './string';
 export * from './style';
+export * from './vis_layers';

src/plugins/expressions/common/expression_types/specs/vis_layers.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { ExpressionTypeDefinition } from '../types';
+import { VisLayers } from '../../../../vis_augmenter/common';
+
+const name = 'vis_layers';
+
+export interface ExprVisLayers {
+  type: typeof name;
+  layers: VisLayers;
+}
+
+// Setting default empty arrays for null & undefined edge cases
+export const visLayers: ExpressionTypeDefinition<typeof name, ExprVisLayers> = {
+  name,
+  from: {
+    null: () => {
+      return {
+        type: name,
+        layers: [] as VisLayers,
+      } as ExprVisLayers;
+    },
+    undefined: () => {
+      return {
+        type: name,
+        layers: [] as VisLayers,
+      } as ExprVisLayers;
+    },
+  },
+};

src/plugins/expressions/public/index.ts

@@ -132,5 +132,6 @@ export {
   TypeString,
   TypeToString,
   UnmappedTypeStrings,
+  ExprVisLayers,
   ExpressionValueRender as Render,
 } from '../common';

src/plugins/vis_augmenter/common/index.ts

@@ -0,0 +1,6 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export * from './types';

src/plugins/vis_augmenter/common/types.test.ts

@@ -0,0 +1,33 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { VisLayer, isPointInTimeEventsVisLayer } from './types';
+
+describe('isPointInTimeEventsVisLayer()', function () {
+  it('should return false if no events field', function () {
+    const visLayer = {
+      id: 'visLayerId',
+      name: 'visLayerName',
+      field1: 'value1',
+      field2: 'value2',
+    } as VisLayer;
+    expect(isPointInTimeEventsVisLayer(visLayer)).toBe(false);
+  });
+
+  it('should return true if events field exists', function () {
+    const visLayer = {
+      id: 'testId',
+      name: 'testName',
+      events: [
+        {
+          timestamp: 123,
+          resourceId: 'testId',
+          resourceName: 'testName',
+        },
+      ],
+    } as VisLayer;
+    expect(isPointInTimeEventsVisLayer(visLayer)).toBe(true);
+  });
+});

src/plugins/vis_augmenter/common/types.ts

@@ -0,0 +1,50 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+import { ExpressionFunctionDefinition } from '../../expressions';
+
+export interface VisLayer {
+  // will be used as the column ID
+  id: string;
+  // will be used as the name when hovering over the tooltip
+  name: string;
+}
+
+export type VisLayers = VisLayer[];
+
+// resourceId & resourceName are required so that the
+// events flyout can partition data based on these attributes
+// (e.g., partitioning anomalies based on the detector they came from)
+export interface PointInTimeEventMetadata {
+  resourceId: string;
+  resourceName: string;
+  tooltip?: string;
+}
+
+export interface PointInTimeEvent {
+  timestamp: number;
+  metadata: PointInTimeEventMetadata;
+}
+
+export interface PointInTimeEventsVisLayer extends VisLayer {
+  events: PointInTimeEvent[];
+}
+
+// used to determine what vis layer's interface is being implemented.
+// currently PointInTimeEventsLayer is the only interface extending VisLayer
+export const isPointInTimeEventsVisLayer = (obj: any) => {
+  return 'events' in obj;
+};
+
+export interface VisLayerResponseValue {
+  visLayers: object;
+}
+
+export type VisLayerFunctionDefinition = ExpressionFunctionDefinition<
+  string,
+  VisLayerResponseValue,
+  any,
+  Promise<VisLayerResponseValue>
+>;