Add interfaces for layering data on Visualizations

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

@@ -44,7 +44,6 @@ 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[] = [
@@ -64,7 +63,6 @@ export const typeSpecs: AnyExpressionTypeDefinition[] = [
   shape,
   string,
   style,
-  visLayers,
 ];
 
 export * from './boolean';
@@ -83,4 +81,3 @@ export * from './render';
 export * from './shape';
 export * from './string';
 export * from './style';
-export * from './vis_layers';

src/plugins/expressions/public/index.ts

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

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

@@ -3,22 +3,22 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { VisLayer, isPointInTimeEventsVisLayer } from './types';
+import { VisLayerTypes, VisLayer, isPointInTimeEventsVisLayer, isValidVisLayer } from './types';
 
 describe('isPointInTimeEventsVisLayer()', function () {
-  it('should return false if no events field', function () {
-    const visLayer = {
-      id: 'visLayerId',
+  it('should return false if type does not match', function () {
+    const visLayer = ({
+      type: 'incorrect-type',
       name: 'visLayerName',
       field1: 'value1',
       field2: 'value2',
-    } as VisLayer;
+    } as unknown) as VisLayer;
     expect(isPointInTimeEventsVisLayer(visLayer)).toBe(false);
   });
 
-  it('should return true if events field exists', function () {
+  it('should return true if type matches', function () {
     const visLayer = {
-      id: 'testId',
+      type: VisLayerTypes.PointInTimeEvents,
       name: 'testName',
       events: [
         {
@@ -31,3 +31,30 @@ describe('isPointInTimeEventsVisLayer()', function () {
     expect(isPointInTimeEventsVisLayer(visLayer)).toBe(true);
   });
 });
+
+describe('isValidVisLayer()', function () {
+  it('should return false if no valid type', function () {
+    const visLayer = ({
+      type: 'incorrect-type',
+      name: 'visLayerName',
+      field1: 'value1',
+      field2: 'value2',
+    } as unknown) as VisLayer;
+    expect(isValidVisLayer(visLayer)).toBe(false);
+  });
+
+  it('should return true if type matches', function () {
+    const visLayer = {
+      type: VisLayerTypes.PointInTimeEvents,
+      name: 'testName',
+      events: [
+        {
+          timestamp: 123,
+          resourceId: 'testId',
+          resourceName: 'testName',
+        },
+      ],
+    } as VisLayer;
+    expect(isValidVisLayer(visLayer)).toBe(true);
+  });
+});

src/plugins/vis_augmenter/common/types.ts

@@ -5,10 +5,12 @@
 
 import { ExpressionFunctionDefinition } from '../../expressions';
 
+export enum VisLayerTypes {
+  PointInTimeEvents = 'PointInTimeEvents',
+}
+
 export interface VisLayer {
-  // will be used as the column ID
-  id: string;
-  // will be used as the name when hovering over the tooltip
+  type: keyof typeof VisLayerTypes;
   name: string;
 }
 
@@ -17,25 +19,27 @@ 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 {
+export interface EventMetadata {
   resourceId: string;
   resourceName: string;
   tooltip?: string;
 }
 
 export interface PointInTimeEvent {
   timestamp: number;
-  metadata: PointInTimeEventMetadata;
+  metadata: EventMetadata;
 }
 
 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;
+  return obj?.type === VisLayerTypes.PointInTimeEvents;
+};
+
+export const isValidVisLayer = (obj: any) => {
+  return obj?.type in VisLayerTypes;
 };
 
 export interface VisLayerResponseValue {

src/plugins/vis_augmenter/opensearch_dashboards.json

@@ -3,5 +3,5 @@
   "version": "opensearchDashboards",
   "server": true,
   "ui": true,
-  "requiredPlugins": ["data", "savedObjects", "opensearchDashboardsUtils"]
+  "requiredPlugins": ["data", "savedObjects", "opensearchDashboardsUtils", "expressions"]
 }

src/plugins/vis_augmenter/public/expressions/index.ts

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

src/plugins/expressions/common/expression_types/specs/vis_layers.ts → src/plugins/vis_augmenter/public/expressions/vis_layers.ts

@@ -3,8 +3,8 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { ExpressionTypeDefinition } from '../types';
-import { VisLayers } from '../../../../vis_augmenter/common';
+import { ExpressionTypeDefinition } from '../../../expressions';
+import { VisLayers } from '../../common';
 
 const name = 'vis_layers';
 

src/plugins/vis_augmenter/public/plugin.ts

@@ -3,8 +3,10 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
+import { ExpressionsSetup } from '../../expressions/public';
 import { PluginInitializerContext, CoreSetup, CoreStart, Plugin } from '../../../core/public';
 import { DataPublicPluginSetup, DataPublicPluginStart } from '../../data/public';
+import { visLayers } from './expressions';
 
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface VisAugmenterSetup {}
@@ -14,6 +16,7 @@ export interface VisAugmenterStart {}
 
 export interface VisAugmenterSetupDeps {
   data: DataPublicPluginSetup;
+  expressions: ExpressionsSetup;
 }
 
 export interface VisAugmenterStartDeps {
@@ -27,8 +30,9 @@ export class VisAugmenterPlugin
 
   public setup(
     core: CoreSetup<VisAugmenterStartDeps, VisAugmenterStart>,
-    { data }: VisAugmenterSetupDeps
+    { data, expressions }: VisAugmenterSetupDeps
   ): VisAugmenterSetup {
+    expressions.registerType(visLayers);
     return {};
   }